User:Raphi/Import ROM map from Ghidra

Limited support for importing a ROM map from Ghidra. TODO: We need the ability to merge the wikitext output into an already existing page.

1. Export your functions from Ghidra using the following script:

/* ###
 * IP: GHIDRA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

// Modified by Raphi for boktaihacking.net:
// * Exports entire signature, not just the name
// * Ignores thunks and FUN_ functions

// List function names and entry point addresses to a file in JSON format
//@category Functions

import java.io.File;
import java.io.FileWriter;

import com.google.gson.*;
import com.google.gson.stream.JsonWriter;

import ghidra.app.script.GhidraScript;
import ghidra.program.model.address.Address;
import ghidra.program.model.listing.*;

public class Boktai_ExportFunctions extends GhidraScript {

	private static final String NAME = "name";
	private static final String ENTRY = "entry";
	private static final String SIGNATURE = "signature";

	@Override
	public void run() throws Exception {

		Gson gson = new GsonBuilder().setPrettyPrinting().create();

		File outputFile = askFile("Please Select Output File", "Choose");
		JsonWriter jsonWriter = new JsonWriter(new FileWriter(outputFile));
		jsonWriter.beginArray();

		Listing listing = currentProgram.getListing();
		FunctionIterator iter = listing.getFunctions(true);
		while (iter.hasNext() && !monitor.isCancelled()) {
			Function f = iter.next();
			if (f.isThunk() || f.getName().startsWith("FUN_")) {
				continue;
			}

			String name = f.getName();
			Address entry = f.getEntryPoint();
			FunctionSignature sig = f.getSignature();

			JsonObject json = new JsonObject();
			json.addProperty(NAME, name);
			json.addProperty(ENTRY, entry.toString());
			json.addProperty(SIGNATURE, sig.getPrototypeString());

			gson.toJson(json, jsonWriter);
		}

		jsonWriter.endArray();
		jsonWriter.close();

		println("Wrote functions to " + outputFile);
	}
}

2. Convert the JSON file you got to WikiText using the following Python script:

# Point this at the .json file generated by Boktai_ExportFunctionInfoScript.java
import json
import sys

with open(sys.argv[1]) as f:
    fns = json.load(f)

for f in fns:
    name = f["name"]
    sig = f["signature"]
    addr = int(f["entry"], 16)

    print( "|-")
    print(f"| 0x{addr:08x} || {sig}")