ghidra-master/Ghidra/Features/Base/ghidra_scripts/DeleteExitCommentsScript.java
/* ###
 * 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.
 */
// Removes exit post comments for all functions in the program or over a selection.
// " Exit **********" is considered the default value for the end of the post comment.
//@category Update

import ghidra.app.script.GhidraScript;
import ghidra.program.model.address.Address;
import ghidra.program.model.address.AddressIterator;
import ghidra.program.model.address.AddressSetView;
import ghidra.program.model.listing.CodeUnit;
import ghidra.program.model.listing.Listing;

public class DeleteExitCommentsScript extends GhidraScript {

	private static String EXIT_COMMENT = " Exit **********\r\n ";
	/* (non-Javadoc)
	 * @see ghidra.app.script.GhidraScript#run()
	 */
	@Override
    public void run() throws Exception {
		Listing listing = currentProgram.getListing();
		AddressSetView set = currentProgram.getMemory();
		if (currentSelection != null && !currentSelection.isEmpty()) {
			set = currentSelection;
		}
		int updateCount=0;
		AddressIterator iter = listing.getCommentAddressIterator(CodeUnit.POST_COMMENT, set, true);
		while (iter.hasNext()) {
			Address addr = iter.next();
			CodeUnit cu = listing.getCodeUnitAt(addr);
			String[] comment = cu.getCommentAsArray(CodeUnit.POST_COMMENT);
			if (comment.length == 1 && comment[0].endsWith(EXIT_COMMENT)) {
				cu.setComment(CodeUnit.POST_COMMENT, null);
				++updateCount;
			}
		}
		if (updateCount > 0) {
			String cmt = updateCount > 1? "comments" : "comment";
			println("Removed " + updateCount + " exit post " + cmt + ".");
		}
		else {
			println("Did not find any exit post comments.");
		}
	}
}
