From 3067576168758c55c0289018f56929d9bbf01ba3 Mon Sep 17 00:00:00 2001 From: caheckman Date: Tue, 26 Mar 2019 16:27:26 -0400 Subject: [PATCH 01/35] Fix for GT-2682 --- .../src/main/antlr/ghidra/sleigh/grammar/SleighCompiler.g | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Ghidra/Framework/SoftwareModeling/src/main/antlr/ghidra/sleigh/grammar/SleighCompiler.g b/Ghidra/Framework/SoftwareModeling/src/main/antlr/ghidra/sleigh/grammar/SleighCompiler.g index ba0bffac28..7170783b57 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/antlr/ghidra/sleigh/grammar/SleighCompiler.g +++ b/Ghidra/Framework/SoftwareModeling/src/main/antlr/ghidra/sleigh/grammar/SleighCompiler.g @@ -1473,8 +1473,10 @@ expr_apply returns [Object value] ; expr_operands returns [VectorSTL value] + scope Return; @init { $value = new VectorSTL(); + $Return::noReturn = false; } : (e=expr { value.push_back(e); })* ; From 9cd01c9a081066a5a49a6faca5dca3b4e15154ec Mon Sep 17 00:00:00 2001 From: caheckman Date: Tue, 26 Mar 2019 16:29:44 -0400 Subject: [PATCH 02/35] Fix for GT-2704 --- .../ghidra/program/model/pcode/PcodeDataTypeManager.java | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java index d75023a482..8a8bd055f2 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/pcode/PcodeDataTypeManager.java @@ -261,10 +261,7 @@ public class PcodeDataTypeManager { if (type instanceof Array) { return buildType(type, size); } - if (type instanceof FunctionDefinition) { - return buildType(type, size); - } - if (type.getLength() <= 0) { + if (!(type instanceof FunctionDefinition) && type.getLength() <= 0) { return buildType(type, size); } StringBuilder resBuf = new StringBuilder(); @@ -541,7 +538,7 @@ public class PcodeDataTypeManager { } resBuf.append(" Date: Tue, 26 Mar 2019 16:31:28 -0400 Subject: [PATCH 03/35] Fix for GT-2708 --- .../app/decompiler/component/DecompilerHoverProvider.java | 5 +++-- .../ghidra/app/decompiler/component/DecompilerPanel.java | 7 +++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerHoverProvider.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerHoverProvider.java index 0f54d60bcb..63f1cc7c67 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerHoverProvider.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerHoverProvider.java @@ -76,8 +76,9 @@ public class DecompilerHoverProvider extends AbstractHoverProvider { Varnode vn = token.getVarnode(); if (vn != null) { - if (vn.getHigh() instanceof HighGlobal) { - reference = vn.getAddress(); + HighVariable highVar = vn.getHigh(); + if (highVar instanceof HighGlobal) { + reference = highVar.getRepresentative().getAddress(); } } diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java index aed2123de5..4cc5528fb2 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java @@ -40,8 +40,7 @@ import ghidra.app.plugin.core.decompile.DecompileClipboardProvider; import ghidra.program.model.address.*; import ghidra.program.model.listing.Function; import ghidra.program.model.listing.Program; -import ghidra.program.model.pcode.PcodeOp; -import ghidra.program.model.pcode.Varnode; +import ghidra.program.model.pcode.*; import ghidra.program.util.ProgramLocation; import ghidra.program.util.ProgramSelection; import ghidra.util.*; @@ -419,6 +418,10 @@ public class DecompilerPanel extends JPanel implements FieldMouseListener, Field } } + HighVariable highVar = vn.getHigh(); + if (highVar instanceof HighGlobal) { + vn = highVar.getRepresentative(); + } if (vn.isAddress()) { Address addr = vn.getAddress(); if (addr.isMemoryAddress()) { From 05ad1aa9f3a28721467ae288be6769f226f7147d Mon Sep 17 00:00:00 2001 From: Dan <46821332+nsadeveloper789@users.noreply.github.com> Date: Tue, 26 Mar 2019 17:58:40 -0400 Subject: [PATCH 04/35] Updating DevGuide.md and README.md --- DevGuide.md | 137 ++++++++++++++++++++++++++++++---------------------- README.md | 13 +++-- 2 files changed, 85 insertions(+), 65 deletions(-) diff --git a/DevGuide.md b/DevGuide.md index 87873b377e..8d81f21580 100644 --- a/DevGuide.md +++ b/DevGuide.md @@ -2,11 +2,12 @@ Install OpenJDK 11 and make sure it's the default java. -Install Eclipse, at least version 2018-12, and ensure it is launched using OpenJDK 11. +Install a version of Eclipse with good support for Java 11. +Eclipse 2018-12 or later should work. Technically, you can launch with any JRE/JDK, but it's up to you ensure OpenJDK 11 is properly configured in Eclipse. -Optionally install Gradle 5.0, and ensure it is launched using OpenJDK 11. -These instructions assume you are using the gradle wrapper, so adjust the commands accordingly if you choose to use your own Gradle installation. +Install Gradle 5.0, add it to your `PATH`, and ensure it is launched using OpenJDK 11. +Other versions of Gradle may work, but they have not been tested. ## Setup Repositories @@ -83,31 +84,30 @@ cp csframework.jar hfsx_dmglib.jar hfsx.jar iharder-base64.jar ~/flatRepo/ ## Import Gradle Project -At this point, you may import Ghidra into Eclipse using the integrated BuildShip plugin. -If you prefer another IDE, there's no reason it shouldn't work, but you're on your own. -Note that the GhidraDevPlugin requires Eclipse PDE. -Close this project to clean up the errors, unless you are developing the GhidraDevPlugin. +If you want just to build Ghidra, you may skip ahead to Building Ghidra. +Import Ghidra into Eclipse using the integrated BuildShip plugin. +Be sure to select Gradle 5.0, or point it at your local installation. +Other IDEs should work, but we have not tested with them. You may see build path errors until the environment is properly prepared, as described below. +*Alternatively*, you may have Gradle generate the Eclipse projects (`gradle eclipse`) and import those instead. +This is the way to go if you'd prefer not to activate Gradle's BuildShip plugin. + ## Prepare the Environment -There are a few preparatory tasks you should execute before, or immediately after, importing the project. -These tasks will build and index the online help, and place it somewhere accessible to Ghidra when launched from Eclipse, among other things. -This task also attempts to unpack some SDKs and/or larger dependencies required by Ghidra. -We do not provide these packages out-of-the-box because of technical and legal constraints on our distributing them. -These include the Eclipse CDT, PyDev for Eclipse, and "Yet another Java service wrapper." -If you would like to build the dependent modules, please see the relevant sections below. -For now, we will exclude the affected unpack tasks. From the project root, execute: ```bash -./gradlew prepDev -x yajswDevUnpack +gradle prepDev -x yajswDevUnpack ``` +The `prepDev` tasks primarily include generating some source, indexing our online help, and unpacking some dependencies. +Regarding `yajswDevUnpack`, please see the relevant sections on GhidraServer below. +For now, we exclude the unpack task. Optionally, to pre-compile all the language modules, you may also execute: ```bash -./gradlew sleighCompile +gradle sleighCompile ``` Refresh the Gradle project in Eclipse. @@ -128,12 +128,12 @@ Now build using Gradle: On Linux: ```bash -./gradlew decompileLinux64Executable +gradle decompileLinux64Executable ``` On macOS: ```bash -./gradlew decompileOsx64Executable +gradle decompileOsx64Executable ``` On Windows: @@ -149,12 +149,12 @@ Build using Gradle: On Linux: ```bash -./gradlew demangler_gnuLinux64Executable +gradle demangler_gnuLinux64Executable ``` On macOS: ```bash -./gradlew demangler_gnuOsx64Executable +gradle demangler_gnuOsx64Executable ``` On Windows: @@ -165,19 +165,20 @@ gradlew demangler_gnuWin64Executable #### sleigh -The sleigh compiler has been ported to Java, and Ghidra will automatically compile slaspec files that it finds are out of date. -The native sleigh compiler may still be useful for those who'd like quicker feedback by compiling from the command line. To build the native sleigh compiler, install bison and flex. +The sleigh compiler has been ported to Java and integrated with Ghidra. +The native sleigh compiler may still be useful for those who'd like quicker feedback by compiling from the command line. +To build the native sleigh compiler, install bison and flex. Now, use Gradle: On Linux: ```bash -./gradlew sleighLinux64Executable +gradle sleighLinux64Executable ``` On macOS: ```bash -./gradlew sleighOsx64Executable +gradle sleighOsx64Executable ``` On Windows: @@ -186,38 +187,15 @@ On Windows: gradlew sleighWin64Executable ``` -### Get Dependencies for GhidraDev +## Run Ghidra from Eclipse -Building the GhidraDev plugin for Eclipse requires the CDT and PyDev plugins for Eclipse. -Download `cdt-8.6.0.zip` from The Eclipse Foundation, and place it in a directory named: -`ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/`. -`ghidra.bin` must be a sibling of `ghidra`. -To respect the CDT project's resources, you will need to download the file using a browser, or at the very least, locate a suitable mirror on your own: +To run or debug Ghidra from Eclipse, use the provided launcher. -```bash -cd ~/Downloads # Or wherever -curl -OL http://$CHOOSE_YOUR_MIRROR/pub/eclipse/tools/cdt/releases/8.6/cdt-8.6.0.zip -mkdir -p ~/git/ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/ -cp ~/Downloads/cdt-8.6.0.zip ~/git/ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/ -``` +# Building Ghidra -Download `PyDev 6.3.1.zip` from www.pydev.org, and place it in the same directory: +To build the full Ghidra distribution, you must also build the GhidraServer. -```bash -cd ~/Downloads # Or wherever -curl -OL https://sourceforge.net/projects/pydev/files/pydev/PyDev%206.3.1/PyDev%206.3.1.zip -cp ~/Downloads/'PyDev 6.3.1.zip' ~/git/ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/ -``` - -Use Gradle to unpack the dependencies for development and building. -First, you will need to uncomment the GhidraDev project in the ```settings.gradle``` file. -Then, from your clone: - -```bash -./gradlew cdtUnpack pyDevUnpack -``` - -### Get Dependencies for GhidraServer +## Get Dependencies for GhidraServer Building the GhidraServer requires "Yet another Java service wrapper" (yajsw) version 12.12. Note that building the full Ghidra package requires building the GhidraServer. @@ -235,23 +213,23 @@ Use Gradle to unpack the wrapper for development. From your clone: ```bash -./gradlew yajswDevUnpack +gradle yajswDevUnpack ``` -# Build the full Ghidra package +## Building the Package -If you've followed all of the steps above, except perhaps importing to Eclipse, you should be able to produce a build. Before building, you may want to update the version and release name. These properties are kept in `Ghidra/application.properties`. If you want it included, you must also build the GhidraDevPlugin module first. -We do not yet have instructions for building the GhidraDevPlugin. -It should be relatively straightforward for anyone familiar with Eclipse PDE. +Some supporting data will also be missing. +See the sections below for instructions to produce these components. +You may also be able to copy some of this data from a previous official distribution. To build the full package, use Gradle: ```bash -./gradlew buildGhidra +gradle buildGhidra ``` The output will be placed in `build/dist/`. @@ -273,3 +251,46 @@ TODO ## Building FID Databases TODO + +# Developing / Building the GhidraDev Plugin + +First, install the Eclipse Plugin Development Environment (PDE). +By default, the GhidraDev project is excluded from the build. +To enable it, uncomment it in `settings.gradle`. +You will need some additional runtime dependencies: + +## Get Dependencies for GhidraDev + +Building the GhidraDev plugin for Eclipse requires the CDT and PyDev plugins for Eclipse. +Download `cdt-8.6.0.zip` from The Eclipse Foundation, and place it in a directory named: +`ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/`. +`ghidra.bin` must be a sibling of `ghidra`. +To respect the CDT project's resources, you will need to download the file using a browser, or at the very least, locate a suitable mirror on your own: + +```bash +cd ~/Downloads # Or wherever +curl -OL https://$CHOOSE_YOUR_MIRROR/pub/eclipse/tools/cdt/releases/8.6/cdt-8.6.0.zip +mkdir -p ~/git/ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/ +cp ~/Downloads/cdt-8.6.0.zip ~/git/ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/ +``` + +Download `PyDev 6.3.1.zip` from www.pydev.org, and place it in the same directory: + +```bash +cd ~/Downloads # Or wherever +curl -OL https://sourceforge.net/projects/pydev/files/pydev/PyDev%206.3.1/PyDev%206.3.1.zip +cp ~/Downloads/'PyDev 6.3.1.zip' ~/git/ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/ +``` + +Use Gradle to unpack the dependencies. +Note that these tasks will not work until you enable the GhidraDev project in `settings.gradle`. +From your clone: + +```bash +gradle cdtUnpack pyDevUnpack +``` + +## Import the GhidraDev Project + +If you're using BuildShip, simply refresh the Gradle project in Eclipse. +If you're not using BuildShip, re-run `gradle eclipse` and import the new project. diff --git a/README.md b/README.md index 33534f060f..3254c39b25 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,13 @@ Ghidra is a software reverse engineering (SRE) framework created and maintained In support of NSA's Cybersecurity mission, Ghidra was built to solve scaling and teaming problems on complex SRE efforts, and to provide a customizable and extensible SRE research platform. NSA has applied Ghidra SRE capabilities to a variety of problems that involve analyzing malicious code and generating deep insights for SRE analysts who seek a better understanding of potential vulnerabilities in networks and systems. -This repository is a placeholder for the full open source release. -Be assured efforts are underway to make the software available here. -In the meantime, enjoy using Ghidra on your SRE efforts, developing your -own scripts and plugins, and perusing the over-one-million-lines of Java and -Sleigh code released within the initial public release. +This repository contains the framework and core features. +More often than not, you can develop extensions and scripts without modifying the core framework. +Nevertheless, we appreciate all your contributions. +Try out the GhidraDev plugin for Eclipse, which is part of the distribution package, to get started developing. The release can be downloaded from our [project homepage][project]. -Please consider taking a look at our [contributor guide][contrib] to see how -you can participate in this open source project when it becomes available. +If you would like to contribute to the framework and core feature set, please take a look at our [contributor guide][contrib] to see how +you can participate in this open source project. If you are interested in projects like this and would like to develop this, and other cybersecurity tools, for NSA to help protect our nation and its allies, From 3cbd8de918e6ca811526e9706980d2d518c02cd6 Mon Sep 17 00:00:00 2001 From: adamopolous Date: Wed, 27 Mar 2019 14:16:31 -0400 Subject: [PATCH 05/35] GT-2703: fixed intel hex export issue of dropping bytes on selection --- .../help/topics/ExporterPlugin/exporter.htm | 6 + .../images/Intel_Hex_Options.png | Bin 6240 -> 8014 bytes .../src/main/java/ghidra/app/util/Option.java | 9 + .../app/util/exporter/IntelHexExporter.java | 220 +++++++++++++++--- .../util/opinion/IntelHexRecordWriter.java | 23 +- 5 files changed, 225 insertions(+), 33 deletions(-) diff --git a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm index 27f1bb5d34..2166be79db 100644 --- a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm +++ b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm @@ -306,6 +306,12 @@
  • Address Space - Specifies which address space to export as Intel Hex format only supports one address space. This option will be intialized to the "default" address space.
    • +
  • Record Size - Specifies the size (in bytes) of each record in the + output file. The default 16.
    • +
  • Force - If checked, this will ensure that only records matching + the record size will be output. eg: if you set the record size to 16 but there are + 18 bytes selected, you will see only one line of 16 bytes in the output; the remaining + 2 bytes will be dropped.
    • diff --git a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/images/Intel_Hex_Options.png b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/images/Intel_Hex_Options.png index 31e0df87d2f5b3292dece58a88777de556cd99ec..19ecef3db6d3da860dbce4b104958453a5478351 100644 GIT binary patch literal 8014 zcmdUURalhW->!;CNJuvbA|>68bVzqMjKClz-7O$Fq?B|H%`kL#DKQQ;NTY<(();m! z_kZte@1yVFJNXXgnRU%I*IK{6?|VHln(B(U*p%209z4KRR+7^OzK?+q4D%821otb( zJa|AyqAVw^>tlY9i(yD?&^;t1`N`B@`tbk@jU1!pn`cFz8P4U1!CD*5iq>Rr_zT}k z#>b#PbtKlTw-owZ7^3u)qe-(P)_lssd*9Q#2yx{+Ytl(^E0;!;XNXh*`%%CA_6$WSYrOp0{U-WA{bsqw(fH}WqZ^iI?@?cUv9cTI!WJmBWeI&OS61`CLP3Nv0${o^OdK!w--dA*+U<8quRy5 zSBQ|i5#HR#)RB6MiB8QhG7V-Q8=Y$NxS*9%*V_v#k^eK@nd6V`d9i$19Rta`XnaM< z4@dewj(CJeAV(r)VP3&nVL<*4)j=^H@+jtWY(7`5PH>)^q!40L#(SI!mM)mTF~E{pjNETi-8I8LHr;YrYdsDa9=JLwjGG!})PHGsFsY5Qp9Yb~@?S@}yR| zSh7~#uT``sB#G2!;_kXfmhWD-FKM`I6G3)d-@Q7zVPjK!^Iq&4CSw;UVGcWgo=3~cJhV_Q^QfCdOH=b% zI<;*c)2nAP)O?_#zi!BdPvZ=yg!?QqHE0j~^S3mGv^?scU`NRxiouuPe{k?ks?pRi zl@33lqZD1gmTeE_7UGMxhps@<)8d(IRPCZQYu9KivRJ81uYxW-o>SV}G0`C5bsdfa zH{UaLk4ZQD5>dgfWgJ9w;-1c6V3>cq4LFcoQHxGG+YqTpY_n_P#VgP2;Z-g1H-#ly zgEw8%6BGNYx|IRkXNhkFOYKo)49d=l=BuV~QopN~e9b&Kit82M?ZrlS;eP$N(5c^h z1^b^fp$Lmwsn{rtj0AqZ=7lY9N&d~gQ)z@fQ&E4)%xp>xF0TL|pBo3Qh^XjrI>LV}42C8J|I zjTTQu9ikcr_|oLD6_Ij=x7%c8a1JmPuiYV7Xu)_5fuJy1Xl?l|xDJ28PsrYVpRz3&-7ZvKh) zxwOvtEnOld_d0tQ?i#l4Ebx`CvyiroI0C40i{Ct=%s#26zX3nq$n&>G)UGe-@FhN=l~g1D7j9 z3W4EwN(@ItCZ$wVa0SLP#=$3N0=(yvbdi?Ej_Vh<{vRz4vQMMg;fEsvDXMra=uydi zwV_swK@+p{9cBL3j+7#*Zbtpiiv z1KC;zv;0<(GyLt|f>L-A9-OGI`tgniH&}#51$DR^g=H_X^Rl@3PIPIidXk1|9zQo$*(KOr+%AHKMi208j>U@4e%>VHd%2p zMCIRk>ssF=)^rZ}QY(nFu5EvE=vQj65*psWL*C?EbDFB@y!fKROW3F~>6?m2D=JPt@FG4Ky%f}|h;dc`F9jy<( zenRZ};kgu~_A~N(iGhJ=jytb}^~1lj{W8n5qWBLoyTHn-K*(kTg8Uxe6Bx3xPH*NghX zYa@nE)^*QV9G%!6szeNOlBD%8Vhhv0mVe0|bFRhGC&QLD2IeTyjF2HQ+0kMN3t9Zc z@VXqz`Y7VRcd?h1qxfiUt^6jxrc+C?y&qehd2<*QGu}|*Ezau@5BC+ zVMM+du+@Aeb5}4DHa>c}ocKfHGpxqxoqdP!vm@)@ky^03CALscO=%8?*`={ zM?Z&C7Yr0?6k`>yiNy{H@fVC9gKVa1p!1l`p1EPo7~2lWD>)UT?e1}NGUdqFs#@|I z&$BcK8F^`@Qg%8w5!3xT9r450^!hIhK^{^Kl+w;-WtI}S8vbU!xEdbu&)H4!;_O6q z#SfDv;G7KxMiC;!kP$ex$S+pds{Th$!Mx|KbVl)jYhv!Sojnmv15y}I6T9!%u3lSy z6nReTUuSBAN4$}w#X~^EE+yxC`mp{$Aq#qR=_=Jssf7;KCNb&y0&TS*cUzjc{{PJg6V$>FD_L>TGXzW(H0|vcK3| zrIszYTz>3xaJ)GRk&VVv%jE7|S-Jglw6W}{=FV&&Xu@@TOV=$ITKhT#;ytSAQV(hI zVR=D}Fyml-1wjStMH!@KSz-~4A@-B`|56a%)zt-qoi~D};qy3S`&I1badHX@f(|o`FJDHQXfbzGK^5aEBd_zSs$NN^ z8`PTn`uQ1~n6x;3tI^1pTw7ZM9|#HNB_~^fK+)qiVDQJp%;wq#I0P~aAkJ_CP29*zySH2O6CCmoUQT4a&9IWX zrR8TRlp`!x)YJN#ICeODOiT=2;OW<)cq$RMj+I!FSIf)GUoNL|#eOX`Mh_U&m@X74 z;tON#bhxfP!m_uwPoNgje)FcvZajTg5Q}Y}KH9rk07ZN&P3P(!Bj>(3l8i(m`}+C_ zUMPI-2jlrQ_#CY-wYXgDFAx!p{a)*@$IIb&(7rfaQC3${8fo>|VVgE#K3y`_rpGdu zS{y3q#8+kW#I1N5sgE!{{8#wl&=&L5}n}~`0FTeT|Q zkEe6&K45(TS|5lh76(mH>*(kNJk-R)#C-d;5Phlmu>OoK*@2JIY9LivlN1yNwrU)( zmX~ez36CVsB#R4<=Mwb)kR4J|QbG}4Q^P3*LUs6(i?Q0EYj?w7i!AlW?5y7u zV$KwZmE;(zWNdYOL**vYGx#-4rt>7)J@*hB6s|=BX+x6)ZWGijjjxOmU1RIMAE#Xf zwTHIkK1D`G+M$=J=gLr{2IZX*)eCbKIy?m_wvp133kwTAUSL$mWvBneab*`x$d7s^ zX{%qT&fiHqX!Qa=Q~~;%J@MpHV)M5oY)JHRID=CRjhGjIfJt_3MrLi5u3OBUP{G8b ztuw+7T4felIeook`?eifo4LMQ@E&>QzJc;4rzg^6AaW zreD+xAcl8wy5j%TSZ77x$L1GJAmI0w@rq-fQAd<9IVxp;GS(}OEKRdUjYoThS;sz% zFq3mRCc(~+jzS@u8I7C0$rC0_OiVswy?WALzI;gn8c-N?)l^?E9l_3VxZ0f$frR&s zLYVW#eZ%bdnRLYsl2s$6N!bZq zNOQR(qN6dK2<+SvpjPbS9~p2HRSfCBf1*dWdVn@<2nQRt`=jxdOZ%Qb)t`qWIZR-3 zlmYm`Nx~>RC&IwMz|1EJM<*vQ-2DChg|VuB<5CIs>}^)?h=@>J{ux@2Z)$EH)mF5^ z7wNdKwfRlLpb=3^0iVaky0s&`wJZ6kBz-P=n+cv8a++t$!s&8Kg4K|!7T)B;D?Xg` zie^Hx0O_GcY8%Q|XaD_X_ftR|_i%rMPg-psP0qyd1qISaU!T-m~2eS7ZTVROPy!uHTY3l7XHJL{St z?Yehqn09mNWSQ{1_JM%peT;ziev5x0l>==LY}YMYVWvJnQjK-fU849aR~fP#sC9lJ zC14uQAJ9aq)ZA6YMrfp25c}a=rsA$o8-r_M)g(W*EZAiQ6KmRMizqL8OCX&=%%wv# znH@_t?QtoVrlC+v{wuu_UtR|;mU$D+MH`2&ruQw9$>?8CEr$6O@+AF(Ufgb>s5CO@ z+J#n`1JCoMK)%da+PU{8kACpg@=mgI?KVm?S>Kq|-zK`)Uw18dH-2ZhZTT2aCMd8DYEg#G@Fy5CkFX+zY5Ts{Q4&95+QS>#!w6AOVB;ByHL-@$T-zHKVSguQQX|z5Fc`vVx=C~ zR=Ac~($VFQXK)#)Rbw5)?soEnYs}hV?|;kyFk3IJX=n(y8BPG&s|YPLH1t?+UKJ^z>MM`790KpyNWr%l7C@ z1uc80NHKIVQBik6mMV&B=>19leUtMNVs1{Ck#H@0;);+Iz{H)NP_(a|mnS>zt*!NX zKQ*DyQG3}2j#9u4!Fc?(#VP|X07DXJ#H_V<^o7VNW1*u_sXa&}Ic=qJEdlYO@vInn zBP_}v)fJeXnmSM~&?R2ijJ;G*YHR{bh=xVTi-!)&={Nx6$n=AMjZzG6JR`FR003Tb z4BPvg9vq)5OkG|5fFdV1cfo`aBx_}Njn`O?WJUJ(zeqGH+%>S9$`SEZX&Z}fgl#WT z5*1`*WSEY%YeAuI%(}yfv3HpOje)^n+X_^)xFZPHAq}b9(^2O9eN<=m0LfuZl`Eb3 zGKDi3+(#~Xz27Jqc$EbAoX3q!I}l?}Y{(5;h?kpr^=B=b?u$voojy`eveG$zUht5_ zXQ;>Z_ia-{gN(t}NmYrliA{Y?0yKHZIV+>Z@60j4n!~uMC&RZt3fI?hnh6`kAix~< z>8mDqrNh@F6YE)eu(lC?jh`q<8Cwm$=DK?^rkfW- z-w;Dv1^89Vrlys_f~~LaQd?c!v(*D&_$BpkZraXSS5|>FX@GMwMLd}H-;6m<{q^eX zU$4{<2v^#}KEQlm6|aA?MmtJidl4=k@P`|36g|DAC^j&fq!3(Ysmi_5=IP<;YU#bF zgVc*GhY5U{pEs+se8_4;lW07#40djwD}m1EsOe6~{ZxG{P-L}032$p#zmxB32MVHj z`=I}+s;X)f4n%LfkH0czaD>pwF61PBFj? zd{}sdgg~{NKq38S`)QyTju0abW)ByB7+M)z*1>{KwsBE3xxEXnDR?xZNj_Ry1bO=P ze?nX98T;X5ou#y%4o+tvqC3^pvU532KFSEFUXklRskf#W!*?(DTD1Ziu_~soW~@I8 znii^V%|I46xE%Yl9Dy*z0lL~FTMr#8M*uCZ19~!-r$#&_=co=uh5%`-RPL}x3HW%_ zla!qNa3h`dp`OxnjUdOuDR4@eEmNfzLpjA9!c(PliE_`!kQCzfnNTw_LiBo^8uzbs znrnwjJp%?6Ft^%50sXdi*Ds6P6F81f=;##tpa52i`RsqjqM}J4l7Z0{mafebCOeQj zz?wRQ-z*>>qG_V@81uidP`X8mGTv@2zNsBP3>LHW{~BTuXImR@M2;C1F6}m4Avm2c zH9a{wIWh4uF){Jk<9~j)db|A9G0(5gQ)zKLCVDjiWx>Cubi~*VXx#}X8{*lM(YwK# zuJx~ygAhD2Yv9k77@WZ}GBVcI>v3dU@L<@iaPMnwY8-6YjRgIZxp1h&R3}9}zJ5|` zs8;=6@=(PX{fI)Sv~Q08Bn{Nh(mEUqj(B@xsYy=h-Snx97AyeHiniWj!tsw}*5(U=Z(Y{e zKe{P!a#kjT6sAW}Q>frZJ;7Dl`il?t`2OmP&fRS3OE)wE0r}wP#V4C2|7;C-4foOv zZ)j);2?>#pBW-PM_4VVrs+}2NvZ_Ix#FG1z~&8{b>N7j0r(VgE7znSm@RQK0nWeAf=%eyUo zZlC{8ax)4$&an(+up1Q?71`L?4G!__1)t3uEG{lWjhlG|1YSx9m{8NuECG577>4I~ zubrXTL>DPRCQe2xJEqa$YD{!#_~(YtB0twJxv;b#n!j9Id&S|Iwc(jeyO`@J3#0$d z%$bjY$%Y7yY+PL2hCa7tG7S}#iJ_se^#CR_Gc#cXYjaamscKeAW+vvisIYL7aP=x6 zc>w}WN<#AT<;(hBw~e7r03A=ZClwSF_9@DtY1Z5=1Bj{tuSU7Uvp~CDFXD{WcK?)s zFZMbGyG4m@IIADsUzx=T<}U`!6<2)SgxqWkkj(lrFj)(CCxGLbQi zEhFn@Ee1%Loc_7(*e`mBFBY6IH~0P}9lu2YS?@c@)aPaGmiDQhG*L7IerME-kN)F( z9D!tzGCpro?48ZuwjOR@6s4CIL{%Boy1ya^xR5eHLobRU`1*@$ML&ab`6zp_!Zl~axj*`)tVV0IJ zKTr-mD#VK>t^7{&y>F$T+%pOo3_d#r%_T$YdwOOT1_vWe=+jEe%7mN{`^&8!EWoXc zY%`RPk8jOV^(P6`F6sM1BWNpJ+tF!$S2dZuwxY7RWO=0h&9JWlM8kNuHHRtsN~cE1 zdBJ@A9fe2)wE3!5uJ^5;R#lC~jlnhNlQ`NF4eb|c`bvdj@_ql7VadcJwDIs}r*G-0 zsoymjk}d60($h%^2_KmNBFkor+kI0>{5&}z67~d0cHd7CUS2{we&%l1A1m!b>)waU z(wAp@-!3mNbNI@qqph8sg_K*;N>=pKyD3M^N7t?^i)If?ITnMK^?z-6U8#L)Ipnqs zY$17BTq$36cyOSfa$FW?F8Gc2UBPV8Udp!{NJmxXT}B2E|KZ#Dq9?E?04*5KSt*o{ z1E?OcU~@}LG#A0}h9yvRVqW`j=OsbLq%s9NSkUk94=cGPTAY_irI#_D4H)!IP2pKk ziK}_-exVl@&h&V4cBu)53aA%$SL+5-_(GjI(srl*yzy3OyPF|=r*{x1_Lw6>v{~RG zeu58d<7VIr2(&FKaPqlDNz%@A{>i;h-RIBWzZNOxd~ZK4K(^f)l(faEc#`okM9Rk- z**=deVfm+g6eojxQ7nHnfv0n&p?}_Ab>?ry>iaTMf!X=u_zu#aaH7(#4qdCYscQkd~`JC!v|si^XmNke3us(vORyH?WgQz z%g4tb&w*FQtzi$)D$?QrDfa{H)~d%Bhor~_5h Tsxt7N{DHE(x?GKnW!V1$hx*SQ literal 6240 zcmb7}WmH_vvapkoAV~%Z?(PZh8XQ6(gy0a|2X}%6hT!h5K>~vf!6CS70t`NbyThOZ ze3Ns|de2?opS$jlUAtHJ?$y=R)m2aT4p&oE06Zsq{^-#ofRduDI_iCjdh#)!pri|~ zd)cE$B+N>(QW{?K2iaIU_*>9^dg?EdZy(D&b7q~j)dU+6vMawzEnoJi(|o!Y(so#( z^_z~U>UpKR+%wO}pAlNUY%JvkVPD_khB3aKEA!e@PafZ>uTSn+d>Dx%NuhZj&5#9m z&Dlvm%h83UKeW2S7<8l@94ck$21iC(-S?o0%pd$2G2cA>^X)6GSr};o(f8uw&GmJ$ zFX!8xAPmnVSep#49_IHKk7fFBc^Te(?Vy(MRh;=Y0idx|)Kk;YaLc4|!&KCJ6bPro zqi?QdHD1;;_hD90q42}B~1>+9=bVPUw~LOOEQ91BdFjBh>| z@L&C`oo;|~{jJmSVZEwZmgmlYOk>ljf>^`^jAja*m^|R*L}H|fh;}X;6H4(dfs?^t z@W6ng;`N^*WhDxy>Ij+)TlmE~PD$2S)FFZG5`Xs3xU#)xrVHufOSOBRp)fP&9@iI5ty){ms}$xde~ zdOHl1CfSDM@n22ZXU4^S4J4>way9mJVvRZ{y(X?=Z;UDZl%|I0r!w{Um@Is?;O` z5|knoL7AG>l%enJ{HKd3vS+m^kO#c3$Vdw5Dxgr3miF}x;%hgh*If-KH9hG|)c&r{ zq0E%L(LQS;jg+JLXi29{ z&I(%}E4hlIT7$ipm(V+G|14GYK6uPCk6j;m; z_DANOdeaW}|LT$>G*-O77BxopOck}LYYs9Z)XwV zYi{kEZnH)P=?!COv;pq%b9ez;GJb znBwivtXEjeuE&YNfjd_f)orUKl!?n>Q7CDN{ua7W;8L{WMIzvvTiH0YuPP8)L{IA6 zzWrK)qShzFdj4>Pdai9HeXd$iNaS!ALG2nYLN}l#Gd3G*%PEa=>4oa*>iI}qhSCKO zc$^AxMKQBybNEc9w_kDo z`nAoMFE>rDTT^}=p-d>#2<+;e!#_l;T|TBp`Ad=WDz*>SH|a}@mcliB{I$Z%s*H$f z&I^e4+gCdnMnXU{9RuHylLHRv{Na#K`vQ<*ASK0TEvm*i7AYvUXQ)l)xP^rh$ZtOw zd-5_nDm?bZt!*V}!r$a6hrC{COQDmp4qHHDSauvjz>cVOQPsMEZ(Umb-Jfg97YE-y zAsKahhVc}qUB$1$MtX~GX1Fm6l=RqHgw<>`9z@WkuIe1g(@6Lj%)Jm*X1KD6=Kws? zpZ=}K&&qLv&rXt#qorFI$+gB-*Vc#+B8Hdsc~tFtgt zBHCs-uLMMr0ma$bM=a-}nM01=4*f4z)|XfZR4{dS4%Ont90q^S^09uzm^C_{mUq*D z4iV0oN%TC$`y1mep^yFTumJ$^&c~tD?RyY=uXl|KQ6*RFaBivKzri@&G3C7c#7l&; zm${@pj4}6i$ax?8oJ|~IdpbSUe26vpvSnnG$Wgj+KxeAdRBXAGmdFJ>?k#Zv zH?1P`uF`4Iz_t+9=g_`jnrIp~?7(1@==?|+ge499s0lF^l-eeG*^PPifE(rn~Qz;13za?e@zf>F;E67|W4y*+IZ|i^R|7m4mX)FSH(A=Li z55RX#7dXZ4I1tXJ4p@VFd*O-66w2QFo+~z#M{Ur#jANrchXJ_fwT<pT}R7zht-!5tnpcx$p z=6`OB6Ezu!h?& z`&JyFQic6Mm;tr#JLEL8&-ERV&}wwL8X$qK(3uek*p)0gfGFGrEaMn}6}J;>kI}z> zlagZ*%enut2BB&yv73TDCvQ@S(HvWEb?)RTk~ICGd!%WBJpZU~;dhkkBl&=IU0M^7 zF+A~GtRKfAL@(aHZx7m{P}?L>+XQnl2Y57zG`DJufn!)bwQN>LEiKkk+$}9PhmzTg z)PFPwQ;K?!kdx1d!>Sj5`Q3H|qTw^W*Qqw{jHg%NV+VTtG{n_$V$r;`5I4u*^-`FN zqqG1CgKEWETU)bOUz=11k3S=YEngbI8ZE^AZrlRja=C7f^s(+eMniWyf-QA-chAk~ zz9vcpKhOp1d$Vsv>AGc5mc&|d71(d|^XkCY+~msXt;B!5c5H?8>C6_ZWX4d6)&pk_ z50_e^RiGy)CttpNAtfbsEXDNZ*NvqTCp!|?*48#iNl18QWCWM+yGhH)xHy78toB9@ zQS@w$X3o^x>x)&+R2f}fULH;TNK8(i{#~eWO(E8u$fWY88jNAbMqT}}W^q6)mDdVF zB0AQvpy7Xmu{o|D;z)K(m^tZZL!ZK5X|o5d7|#+0J-%J;1PysB))Vk2K}k9{54)3Y<@23a~h-^J?gP@FSiX4S0ig$B-`gM|ids2D$bvLZu* zM$J@ltfk57t}Q|D)A-zv>+?M#+j=e=hl=eJEtPfw4J z$5YM3fqI1?lK8PB&N_vSw_KXUxVX4jS$F1Yt>_hEda&4CotPqt-VBY7`W>}ha^*#l za6fTh?xzk|thM?e!7L(jGxg&WS&BOxkqm~1*v1c)FNu-YfF-Y%K|el~baf8o-$XQQ zD5|QeDl6C4)_xk&{+vafqITcc+iNn_KiXaW)X&Gq$Bbgt)oFpo?>(P$t>aR&rm`BL zr>7?i`6bndB%ZKtlb`w!b0rN80tTR|smsPR(cUlSJ(YbrM#|b1RPTf60?9Hq_O%lduR$aeCP0Di*3cz`UTwXSok?9uH37)-j zsn4i`m9u9>q@{gqECz~->A4{0j;nm67P`65^fQm55 zniDN8ZCU1PqhE`Qiw532UXL{Nr?XA&ETS>=n<7%*R-qQpRYylhV?15dljCOWw)8Cw z3~s41ZLU(AWh++L&=gqxv~rABF87{383ER<)vL4J=n5oeJmfQs2{T*&S_QUFKGh`N zat~=ck#J!CgQEZ6%AKBYzfhr{k(u+Y-e;_zijCiHBm!S*F*BpkSpf|V)Ya9+7K(-| zZu?58#p56-1h%lpq7C;O}+B-Y;3?JKbBpy^o3qxB#|c zve?MmP#23ihy^D=E1-de`B7P@*#q(MlgFy)2%IF;g3>;n0qb@TXGoI1gq5|F-Mu82 zg_g!T^LUY+fD7JteJg7LpWI7Dmzd~!>gf$KQJGpr`&99KZcS@b0>_5gN^gym6@f1g zmtHXbNU25k#8WrGytgPvT%5FVf7aJ)p**m4==l2n_K3bKl}Jub?%A_v`$z0Clr4U@ z0z=j>OVhM9k=q5ud9MhtyyT9JZj4tk^Yi?daWMRhq2EGX?~&J~70#F=67g|qX<_}2 zv(+YLTOqr`e0&5FMmOc6-63zJ)fU$fK{aNR#VU%q=?=>*8H_F>0 z(<3cDwYELD^Us~4oLV~6*|0FF4g~7{u9R5zG=FNPJG5Ks@e;&BnIIcCI5jm@oo;tk z(;Q%8!V|&wK3R=+IfvHT#wOhNWkDJc*6N)&4(2Y^(_FJ8Cnco?G>1wgh03V>sWDRs zLyy3E{(N;!Iv@9)G~wae8d}9!Z67K;tgnUl2F}+3`%^{ub4)-14$%r>xp)#Q)+4$4 z4Y~svx*Howj=CBKTn5UUl#EDBT6|8DW^I$d0q&W-Jkz85(^r?Omb}H zbqS`K7(--{Ek0}+>1EK9A7y1_W#$&JLkhjx@cwkA5;kZR#ck#Ee$#afNgU(6k+<`t z&y=ZfsU6EESi@Tw>24?b;C8ZN3a|YT&|0+y5y_<0L!g*I;rc+@8r|3n1K+SyvZ8_dGzEpq8p${zj%g{Grq^j7%SX*ejfu=e zB6seae6=R1eK;gl^4ep5%O5V@G0N+`!gX~#X^#uC>hRoQY5dnmx;JctQ*!0E?f9#nE3CUa!;l2@DZass2^AFW{6jwfKilB`8;ux% zDB6KA{g;UT)|;#Rr}aPG2Q&VX(qCTsANBtetNwO}F#Vr!>jd3G1-JPrJ1_*ragW>T zF_%F9+aUIF?nyt_hk4s$<`JQH#p<`CMf>WR07@y(i61k+XfFMmv<(biCl0EstFO8} zaeKNXRWeb>M7viyl7NMAPf}CvwkXvE%v(g@HcZK{jV&I;`66d5=sku%;~>K;+hF{i z2Om^aP)QMoN^ByUnmnI=8(ZXCB|ny~PY7~zABVNtcKN-;eV)gBBu91I+Y&Juf4??h zP#}PAqRr?}{-9**@DE-*CAuclehc z3tp+h&ys}MM+S5Gx4wpO1$gJ$1UiOWc{(F|HrGCPdmt|9*OsMryZ4ZgiNXff^#(q8(v zVk^1=<_dGm2OFT8b-S>xAF)_7OF;W+_yG7!Uxr8zaK=}^ZMnGe`8N65w>;beXV1j2 z)p28euB@$YyZoW*Nb2{qWW$axUMcOHd?IYSnj0>choANJ7cLGK#?yJN4(96)4-d7p zwDR-wQB3vMeC~p=E-P9gyhYu&2%boPe1N|GY=w76m54ur+APv@!HvA9icJ5)3z$Zn zMfC~vU^zAK@dJFX0QNlvPuhP>?=wGGUHy|U6S~mgs7>0g1a*{$LSGDF*sa>pPpUy3 zr$LrCqocPfS^y6+hz1RA>sI{ZcFj<#?E6Cmtl*qTzWB)BrT8&U#XPZ_3NNIO2}OD2 zf)3!C>6w{^54jS>#l?5Gm+f9Bbkr2$U-(w3sHiqKH`{zJwfeYs1Flv=QF8*Kl2n7k z(iKfk3av~C3SvEX{>WXU)9B8~r+UAKBLH?wR(;Z)P<)Uk=x9vE6omg|rQzqcjf3Dq zwR?%GsszB_ttcOu5zoJAvaRRh;u2lK0!d6r$PxDua9LMG<=`Tg(UB3R4>_;n6=~-F zf{e2w{Li1$*&4IV&X)wQBafU zq~EhiKSC>Zg8DK;Oa5E3!{Bd|Ow-0Qlfm_GG{plvcvP?ZRdcfW?z@0oX}4> zz72#ChE8~Y7eG}-MQ({9nC#r6ITl5)cqLVqM0O zg;WA+m7?kzBHmQB-so9wAX??h>nmVXWn^}u))iE;t;bZp1M?%!q!jq%shjflBIAP< z4^rixopz8A^XMmNMQ14XDi{3R?%(EpwppT@9dxv{rQHIy;2|Z5lKSk9db2hk^xN^1H&qLfXBoED8y0Cn<->li1S9=z#`Cb#Z7wlg&iqJg1duEsk# zIdzzU=FBq%?7OC;)k|*Shq`N7C@yPlItLlA#6%Ua^)wTP}cMGDPhub;DzggWX zlm>2O;8srryppbNCQRb)AC0J5^G5f6bwjEG1> + * Important! If you override this you MUST also override the {@link #copy()} + * method so it returns a new instance of your custom editor. + * + * @return the custom editor + */ public Component getCustomEditorComponent() { return null; } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java index 29242fff3b..eaf04de5bc 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java @@ -15,10 +15,15 @@ */ package ghidra.app.util.exporter; +import java.awt.BorderLayout; +import java.awt.Component; import java.io.*; import java.util.ArrayList; import java.util.List; +import javax.swing.*; + +import docking.widgets.textfield.HintTextField; import ghidra.app.util.*; import ghidra.app.util.opinion.IntelHexRecord; import ghidra.app.util.opinion.IntelHexRecordWriter; @@ -29,10 +34,22 @@ import ghidra.program.model.mem.*; import ghidra.util.HelpLocation; import ghidra.util.task.TaskMonitor; +/** + * Exports the current program (or program selection) as bytes in Intel Hex format. + *

    + * The output defaults to lines of 16-bytes but this is configurable using the + * {@link #recordSizeOption} attribute. This allows users to select any record size + * up to the max of 0xFF. Users may also choose to force a record size for every line + * of output, which will only print out lines that match the max record size; any other + * bytes will be dropped. If this option is not set, every byte will be represented in the output. + */ public class IntelHexExporter extends Exporter { - protected final static int MAX_BYTES_PER_LINE = 0x00000010; - protected Option option; + /** Option allowing the user to select the address space */ + protected Option addressSpaceOption; + + /** Option allowing the user to select the number of bytes in each line of output */ + protected RecordSizeOption recordSizeOption; /** * Constructs a new Intel Hex exporter. @@ -41,6 +58,13 @@ public class IntelHexExporter extends Exporter { this("Intel Hex", "hex", new HelpLocation("ExporterPlugin", "intel_hex")); } + /** + * Constructor + * + * @param name the name of the exporter + * @param extension the extension to use for the output file + * @param help location of Ghidra help + */ protected IntelHexExporter(String name, String extension, HelpLocation help) { super(name, extension, help); } @@ -55,16 +79,150 @@ public class IntelHexExporter extends Exporter { } Program program = (Program) domainObject; - option = new Option("Address Space", program.getAddressFactory().getDefaultAddressSpace()); + addressSpaceOption = + new Option("Address Space", program.getAddressFactory().getDefaultAddressSpace()); + + recordSizeOption = new RecordSizeOption("Record Size", Integer.class); + + optionsList.add(addressSpaceOption); + optionsList.add(recordSizeOption); - optionsList.add(option); return optionsList; } @Override public void setOptions(List

      + *
    • input: a {@link HintTextField} for entering numeric digits; these + * represent the record size for each line of output
      • + *
    • forceCb: a {@link JCheckBox} for specifying the force setting; this + * enforces that every line in the output matches the specified record size
      • + *
    + * + * Note: If the force option is set, any bytes that are left over after outputting + * all lines that match the record size will be dropped on the floor. + */ + private class RecordSizeComponent extends JPanel { + + private HintTextField input; + private JCheckBox forceCb; + + public RecordSizeComponent(int recordSize) { + setLayout(new BorderLayout()); + + input = new HintTextField(String.valueOf(recordSize), false, new BoundedIntegerVerifier()); + forceCb = new JCheckBox("force"); + + input.setText(String.valueOf(recordSize)); + + add(input, BorderLayout.CENTER); + add(forceCb, BorderLayout.EAST); + } + + public int getValue() { + String val = input.getText(); + if (!input.isFieldValid()) { + return 0x10; + } + + return Integer.valueOf(val); + } + + public boolean getForce() { + return forceCb.isSelected(); + } + } + + /** + * Verifier for a {@link HintTextField} that ensures input is a numeric value between + * 0 and 0xFF. + *

    + * Input may be specified in either decimal or hex. + */ + private class BoundedIntegerVerifier extends InputVerifier { + + @Override + public boolean verify(JComponent input) { + HintTextField field = (HintTextField) input; + String text = field.getText(); + + // Strip off any leading "0x" chars if the user has put them there - the + // parseInt method can't handle them. + if (text.startsWith("0x")) { + text = text.substring(2); + } + + // Now try and parse the input; first as hex, then as decimal. + Integer val; + try { + val = Integer.parseInt(text, 16); + } + catch (NumberFormatException e) { + try { + val = Integer.parseInt(text); + } + catch (NumberFormatException e1) { + return false; + } + } + + return val <= 0xFF && val >= 0; } } @@ -84,33 +242,31 @@ public class IntelHexExporter extends Exporter { return false; } - if (option == null) { + if (addressSpaceOption == null || recordSizeOption == null) { getOptions(() -> program); } - PrintWriter writer = new PrintWriter(new FileOutputStream(file)); + try (PrintWriter writer = new PrintWriter(new FileOutputStream(file))) { - Memory memory = program.getMemory(); + Memory memory = program.getMemory(); - if (addrSet == null) { - addrSet = memory; - } - - try { - List records = dumpMemory(program, memory, addrSet, monitor); - for (IntelHexRecord record : records) { - writer.println(record.format()); + if (addrSet == null) { + addrSet = memory; } - } - catch (MemoryAccessException e) { - throw new ExporterException(e); - } - finally { - // Close the PrintWriter - // - writer.close(); - option = null; + try { + List records = dumpMemory(program, memory, addrSet, monitor); + for (IntelHexRecord record : records) { + writer.println(record.format()); + } + } + catch (MemoryAccessException e) { + throw new ExporterException(e); + } + finally { + addressSpaceOption = null; + recordSizeOption = null; + } } return true; @@ -118,15 +274,19 @@ public class IntelHexExporter extends Exporter { protected List dumpMemory(Program program, Memory memory, AddressSetView addrSetView, TaskMonitor monitor) throws MemoryAccessException { - IntelHexRecordWriter writer = new IntelHexRecordWriter(MAX_BYTES_PER_LINE); + + int size = (int) recordSizeOption.getValue(); + boolean forceSize = recordSizeOption.getForce(); + + IntelHexRecordWriter writer = new IntelHexRecordWriter(size, forceSize); AddressSet set = new AddressSet(addrSetView); MemoryBlock[] blocks = memory.getBlocks(); - for (int i = 0; i < blocks.length; ++i) { - if (!blocks[i].isInitialized() || - blocks[i].getStart().getAddressSpace() != option.getValue()) { - set.delete(new AddressRangeImpl(blocks[i].getStart(), blocks[i].getEnd())); + for (MemoryBlock block : blocks) { + if (!block.isInitialized() || + block.getStart().getAddressSpace() != addressSpaceOption.getValue()) { + set.delete(new AddressRangeImpl(block.getStart(), block.getEnd())); } } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/IntelHexRecordWriter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/IntelHexRecordWriter.java index 623417a12a..471842790e 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/IntelHexRecordWriter.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/IntelHexRecordWriter.java @@ -20,21 +20,31 @@ import java.util.*; import ghidra.program.model.address.*; public class IntelHexRecordWriter { + private final int maxBytesPerLine; + private final boolean forceSize; private Address startAddress = null; private Long oldSegment = null; - private ArrayList bytes = new ArrayList(); + private ArrayList bytes = new ArrayList<>(); private Boolean isSegmented = null; - private ArrayList results = new ArrayList(); + private ArrayList results = new ArrayList<>(); private boolean done = false; - public IntelHexRecordWriter(int maxBytesPerLine) { + /** + * Constructor + * + * @param maxBytesPerLine the maximum number of bytes to write per line in the hex output + * @param forceSize if true, only lines matching {@link #maxBytesPerLine} will be output; + * remaining bytes will be left out + */ + public IntelHexRecordWriter(int maxBytesPerLine, boolean forceSize) { if (maxBytesPerLine > IntelHexRecord.MAX_RECORD_LENGTH) { throw new IllegalArgumentException("maxBytesPerLine > IntelHexRecord.MAX_RECORD_LENGTH"); } this.maxBytesPerLine = maxBytesPerLine; + this.forceSize = forceSize; } public void addByte(Address address, byte b) { @@ -117,6 +127,13 @@ public class IntelHexRecordWriter { } public List finish(Address entryPoint) { + + // Before finalizing things, write out any remaining bytes that haven't yet been written, if + // the user has specified to do so via the force option (false = write out everything). + if (bytes.size() > 0 && !forceSize) { + emitData(); + } + if (entryPoint != null && isSegmented != null) { final long offset = entryPoint.getOffset(); byte[] data = new byte[4]; From 00a5a4dc01b9c22656651ff370d518af99d3f7e5 Mon Sep 17 00:00:00 2001 From: dragonmacher Date: Wed, 27 Mar 2019 18:28:13 -0400 Subject: [PATCH 06/35] Tests - fix for failing FG test --- .../Docking/src/main/java/docking/ComponentProvider.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java b/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java index 521b6c2452..6427e1ac17 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/ComponentProvider.java @@ -170,8 +170,11 @@ public abstract class ComponentProvider implements HelpDescriptor, ActionContext */ public boolean isFocusedProvider() { DockingWindowManager dwm = DockingWindowManager.getInstance(getComponent()); + if (dwm == null) { + return false; // can happen in testing + } ComponentPlaceholder placeholder = dwm.getFocusedComponent(); - return placeholder.getProvider() == this; + return placeholder != null && placeholder.getProvider() == this; } /** From 6fad64426a5c9ec8b71c7c6d718859a24ff9e1a6 Mon Sep 17 00:00:00 2001 From: adamopolous Date: Thu, 28 Mar 2019 07:34:36 -0400 Subject: [PATCH 07/35] GT-2703: changed "force" option to "drop extra bytes" in intel hex options --- .../help/topics/ExporterPlugin/exporter.htm | 2 +- .../images/Intel_Hex_Options.png | Bin 8014 -> 8778 bytes .../app/util/exporter/IntelHexExporter.java | 34 +++++++++--------- .../util/opinion/IntelHexRecordWriter.java | 13 +++---- 4 files changed, 25 insertions(+), 24 deletions(-) diff --git a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm index 2166be79db..7cc81d3288 100644 --- a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm +++ b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm @@ -308,7 +308,7 @@ address space.

  • Record Size - Specifies the size (in bytes) of each record in the output file. The default 16.
    • -
  • Force - If checked, this will ensure that only records matching +
  • Drop Extra Bytes - If checked, this will ensure that only records matching the record size will be output. eg: if you set the record size to 16 but there are 18 bytes selected, you will see only one line of 16 bytes in the output; the remaining 2 bytes will be dropped.
    • diff --git a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/images/Intel_Hex_Options.png b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/images/Intel_Hex_Options.png index 19ecef3db6d3da860dbce4b104958453a5478351..8d6087886acedf6d1c98098ddf1be9ed6fc490f3 100644 GIT binary patch literal 8778 zcmcI~Wmr^S+dWE1BaMV0sdSeD5OoAX#K^-(czR*Hg+$CXrq2ah615 zQtGVv6;g0t)W(X8Z|Jg?8KAbJWzD8Iyx%gshCf)bJeE?C*92jWrQbLQ?jF)EXH)*B z^K9&=T@p?0t9~>$H`uC!K6rolFpT9((~mlXlWThDheO=g*C*hx=y`h8mlYIwxYP*c zK)ei*Vt&?c&q-DM47no^Q;_>+X*SW7M~+@C03FRAhq%^Zsl{W9Jw&STeS0A0?bh(Y zTY7?mr>GRnhcr=+y7Anl`i=GON^|A-1rho*^q+!%Rb^{f6DDKo8*k5u_1iOw#K=N>HC703 zLyYx}N0)t&!#WWzc^kbd*=KWD?76q+l@zzjk89d$UD*<1cGzC`So}>%tR?^o^MJ2 zGcU|y#6-BiTay2+nUtd`U8Txu;e@aq1G3Sv^Aj?_p~%g)KQ znmoTq<=d0wC+P4gMdmXB`|B{8@Kx09~x)pTE&xQzE5?vCofotk9jpRrfzZvS4li(y`Jj`S#!#*ER=KQ1`K0iXNPk+5H<8mREif(oi&eWlOt5qf*aTm{^ zuRNwVl>3kY6PN3&lixl6cmj*+*ACt5o33Uy%Wu5LUIBJ8~R{oj|nRLg}>-%tSN z-!-O(?Q5$mL_P`WkbTDz30>a&X{@DeS6+Slj+rY2UY2%RU2Wyc`0hS3-&w@gcA6ST z{CU_AI$U zj_gm(G7m*ji;wC_1{41*#8vdhgEEX-kEgwRoQ_xY75k~Jg$>0L;R-qThhZ*E42;E8OYpgID~qeT1%*t!-YBGq*u5_ z;)h9?uGXoqx|Sw{25U}mbed+ho^Nvw+K{d~a%shVKN`W*MZ!oUbTp7!Hq6z7n~*+O{u&7~j+&;~5115G5;kmlGTrHl2q>8r`Cu_RehvVEU`a zR8p6~50U{r)5jJ5va5mgpHu>i+S)XLYJ`S6sn`)6A{#r0|%eARJSmAtwjH#3-Ex-dVuwvKxzbyo>YubIOBx2(#Ro1K*r zoCGTLR5O~Dj?T;MlpIdQ3ytfNi&gswB9J3dGdhu`jbhfrd_cYjl3z#8jQn#cP!_m| z53E6mqUzXW4!8BCVMec{74LoeUmQ$Oe|ksKV;x{ZFBagWftKo@hNBWJq6E@{#RkU3 z!No|WxuQapcebXVBF;=1HDkc(Q2RO+Zwtt9;+4f}WDU^|;(=tAX=(>Nucq5Bx-!W` z#KjV0pG<1&$X+EsUYQQu;{19i=O*IMtjxolOEv3)ESObGLOs1L2n)~5ovNkwx+5%I zQgie$K_Z%Ry+K>Z-Qnc~S<|(n)qU*Gp2H^P+KuzY{QbrihCjg-6~*R-AK^}@2(|A) z<*V)f9WhW+QD_06tnNt7x{AkP=0o`GAHK3Abl3ckQO0nmg_Nx-cD%iArFNm!$a*PY zeUWD#kz*mlv&j*1JBAOz^G{S)uop`yE3;(%YPVK?sJ|p6WfhjXo;Z+~aR?_qNemU+ zAy9n+9_;ULfIhSc7QQvGs!L1^kF={jm8QPhEw}!Q5*8q1)`~a=RZ;{X~#)bxcek+I)~#_g(vj z6o>K!ZAPFs@bP_(h`OuION3^_74r>HZOjJTc1WBbToFdLy(k^0wp! z9x?$|ssJ-Gfu`(;Scyq}vtad|^czDKlfeSR)|P+(P-h?xwTL_Y@aCwQkp2lbJu7Rm zd@M5t2FB`lrxm*rLCaB^L5_Ft-W}Jx^Sb^Flw1dM)kV6s_IV#tB_t%SxPz6`MVrO_ z(6&vYfBy9H@=E5lGO@Dydb}(SM!OqM;4(GPj~^Akq>f#H4sv)8X%+s?Q^!oLtD1=H zSD(gu=+lA~ABtJ_S83ClvSd>IF48*sU7$`z2E9Ai67{~jKDS?J$dH?znfaxC95+Gi z>gbp#2EG6BO7eOAmpu|4NaRbAAJTO5txz!*!spMIx3`0hvZTYW{+3VCDBIfZdmJ@y z9UQQQuDM{5u#yQm(Z6hQT9sbRJFrpJk$mzOAug`Bbh>gLoJ&9Hr>{eqWohL42> z3+HUH*~8sef>AL6Ng%U1lXTgyj!HWAD`Hc>$qk>sNIh@3GYAh>?{j_o7m=8l=yh}P z#l^)u;Di&1{jJM>+qs{w@71p}3{Xs4DDX{EnaN!~o2lg|5OOnM>F{y&T*V3)%+D(7 z;_|Z0pjjA-X^b8r`j@;UP$Q*|7t4B8?}u_RxLS`!i$z*SMyo`J_~-j}%m34DffT4B2T z=YA!AetsfBzyhlVtE?teT;sa;V~Ve8s!qVw+KGnr4w`Qr=pj-$eG(rvReeGGTU!Ia zLw_@KUV9UzTu-T#5 z9Ad7lPD+QaV0?v8aadc&o8%jJWM>KQlohr-mbAMDfsW43vC#@OlOWpBP0m>TD$6kn zKU&T}1eVUq0jDE~63?%mOXnd?#N)YMwKXw})`JW?+Lxty1>>u{DX94Jm~&fvwABbR zTtHq&I-Zzo*z|s6-2bI*Ts{gjS!3<{0=1)H<|_TdIs6=Ha(v?_$=a1wt2K7>qt^ig zJQqC_{Gu~+a}9NMzZhOwnwi0MKWORkDporzy~O7~X!5#oad#Ic2*RauKVE(k7eH1= z!migVZ;f+m^fV+R;ZE|YgM$OF{U95xem+A9APq8AKY)Y^a2MOtr%zRu=c;YCxv$Un zm^}H5(EvdS=hf{u-*c0| noGa>F2yl(umH?>k?4z1_v3N`JCI9O;DP#|jow#i7{BwZKjGtKt$vf@$sZf z#b4kcu>T8T*Te57051|mGE-m8)H#~Q^cYQ6+e|mQ9#ux`_`QQLWcp0yt0KdfHLI*h zdJZ@ZtINyZOUkfZA`qsIOiWBw-o?yX#gHe^%GN(!Jv~|P++Y03H|`9yB`-b)7tG!`oT+n7_KVER%{3wN(u|P2_LsPVUP(WoX{IF% zF}vl=!pl5Y&wu@;)I{ubTY-e=$o-e7D14nZZyrVporMIb!yZ#0?-{G5AnaFEp3YUj zKd)05f!?1#>XRmMn*-mKUX8%1okM6?tlJt?r!P;<2HNve7@j=5bv5iBqn|A434q?I zcO){OuyZD6@c-TYQqlX}gjj}rSVMP^_0z@J?L%l#*3N?#uY^RY*aAs(_y%om0R_95 z2w54XtOhE5)W=uF$a_kfdlS6jrTe(h;Ri`%AnRMC3 zQd-4KuWQ!(k{=S*DP*EU$e{(ktaV!9EwAMv$KvcJ2+g#KS`NmeuNCL=!*8zbDArKz zv9A#Y4@V>3xSpGc`3X(>ue~?57HF6XcYLI2rtkdmVE1hIo(kC76(+K+@u}{Ya^nX~ zA;7nem&6yyQvA-1A-g}h&y4xCqi8-peH@V?1h5H^LPJLAKYn8^wggycWi?x*RR#$CWWK83 z!`-cGC_9Vw!g-17(PAd`7RQUh(1*Vx(B0n!rWO`?Dz8V+kIntq9%F!6D8HLO+nJDw zpzO0Kz$vG_akLl$e-nOBVyK9@^r}=FhDPo4Nja)ApcQ|uBLHia!0cILd~NOJU&I!u zb%RM@-2_y#gHv8nA>IfTc}V>=8G7VCEnp6UtRA&KM1+MAYUA4n5r6r*6Apg&dHYAH z^H&ulc$bCKvbyDBQ+;wWg>V+5Qj$gySm`=>*z9TJSeuFe+X%Uk@bJl2xS+CvTfQ=%&nH`Sn?G$k_m{IjEDLC?zWZczg{sSM#?46%Y>%4S9KbUPKn5q!LFeS;iii}wMsKDGtM%}57S#9X#TcvJqj-=k=!1JAh6LPnYSMmR=c}DT z@QY-ydlQs0*tb>Ys;vCB*0G9!?VpMZgy28!k1Un1eOOsozWT((rPV@#TJV{)oSa-j zX_-!SD3wV`guu%E-3^cVU_Ow`4};n9lz4Sd$#ewTh&psny2B~98y)dID+!rCtYdwr zdV8@~)*81cYqL}cy&P7fC1uI%@qIGNJL|$VE9@da(U1p7_4MmpDEY-hgleHLrZPxvK2H zy+OH@AjuUfe=dwZLxG6UskW{tT4?%8NNr+d^y^Go=VnUaa8a8a0NWtW=ukpZQbS`S z?AKK4_}P9zH^(uA(4rBH&X#R~C-mmp)yr>WWpYI9A%)7?OQWUyxd?c0Xb5CcWj;ji z5{yCYG{*k-bi)BuWrY2^>Dko>CFoKfG_T+GPzZN%e|M z;tGcov}~}wpi^b}1i91y(-=TQ>#5>C#zn~IHvQu4W9f!#u%ycoE0^B$qcFhVpQiUn2xc?QPFWeqQuQNEWW6fWW?JAZW++)ehI;S;^kFZ{8Wc(F zlbHCzT%I)?^u}rI=Cppp0nX8S8||>v;o8>L!l7HPp7VSsoNQ-jhb)WpBS!1r7#&r& zJGN*bx??4*bVkN}TVp&PQ(2iztBG7d4a^w=1jZ+8$?H5U`hLU{`ve6&6Xu-4uv&Oi zlKN4Z&&b9m>?=B^k=$sJ7Kh%Czfxy?J9Cl|G9#r9`@)~luR)%&naUD-S@L7RR_S1q z3R3OB!$?ho+nz>`uvxIID!pIp?rFyjILh|%qHa}Zc)LDk1}aA4BJ}aF7)pXaJBO(5 zp(W7zD`63`H#N`xS$&$ytr(2f294;T*g4Y0nQexl^bUt^<5zs{?xHdn|A$4#1^wCbCN^0OjSWVuX3Q{$7=6A(1(pl*3?o%8ft|Q!C%FRTR-T5YO>g zu4{AYV3U(DpZ7~{Sb{uJ5@IuY+Iful;7&lG_bti|>SiZYp`+HIVq&g0ZQqe`d!EKZ zk&W^6esVB+V(U{FVHzu8QN0$P1w;v(S~LYdhIA~7pi-(?2S5nEYjlkx(1xgr>9{_! zhMa_H{8zBR;j6qa(*nq2*ZC6uS()s|{$!l7@;R^XrCCfc?)GPS#RmupHN=-^@QQrFyD{)1^Wu!lY5x@nhcsh}*B9R}gE8I`sSN@ilk-H&v{6rftoli=xA{ogLcPP?^!qr?7gX~85=-K>QcHZm zsEPp^^H_NYP-Yi!L3|Q9*~G9qfFJu`H%$J^ehe_ZuNIgdJ=0_iqN?=VA6q5(nF3%0 z{og$x-+ps=+d7kivKaO0z>8XSQ4e*)peTN-OQduslb3bCnF2!9F zRf$dIP1)KAyqXUio5r$kb<_6tms);OT}`)QPNm5MPQ7H!R{c@G^HQHxyc3xMS!x{< zhx?U&|Eu}fyXgnE(h_4S5XhL8$-cK6k2#<)#KvY&gPFxeFHyj)u@aJW_Jd0L&Bd|e z{`1EeIDP&6;3W|6*Rk@k@(d9z82?#f#a-pQTEmzoz=n|}dsAPtS)G1dWH!<_l*(8` zwYIl=Lz+H$k68F%fPZT|KbD+A0t!`zD&Wi%7NC2$U4%Y9mJA@xDx)n@KtRC#{XGoO zdm*Rn`1t9=g~s%EUuoGjTm*%M-QC?ovmBoOXFqHk1xMgovkpHi(;cFCgL1%SM~Bn3 z`;dw35Y6iAZ2Y-~_M?BBJJM%*@Q}dO-={mHv-cQ(sqCPV@bvi3zvM{>;n_ zWM*)7HW6+-4U|6AKqa;@5bx;d==o`;+!$y)^_$(RtE>5-sFfx;m6;pAJ!R58dnTFN zZLG}roT!t`Sw;kn%kK*H;2uYOFUrYxlFZp`1neFRVhg8Capjab3hII^R%yW#1AUPEieyg^S&uaDp4Z`GlvZEDB4rQe5xh8BI$B;f8ZkCE z@Aj3T`+I%O&0=yIvL_`ab-Z=jK2@Sy%NDp0T%4faS8U0pI%$&le!x(SHEKV8-CLzd z+-_d9u&b`}!*4;VC@e<~|d0cK57dU~W}tbBmBjhdR8kr7RCLR?&+_6A_Y+Dw-Y_1jd_ zZjWXlgZ+$+jb+z9UodzB&J%v?R|MnuNV*vGVn1;kGf)y7!+|4Hn8d+q*;2kesfOss zRVYGZPc8(PA;hT=c)L0p1>hp@$c-V=by)FkxX$EW&5xYqVRyBmuG|KzJ#*(Y1&-62 z)wI^v;s25!hH~1glOAd=elXy$0YzAO+|QqcP5yN-m@@zYa$d`F`vqYlBWV4Y865cM zoCd4YC{_5&^DehA8r#Qy2GR`JnCE-bVy=fN|BjEb^U+*j-K?0doYIS(?GhVeWYirT zBDIKZ?$YFR8QdF5xLL; z6~6r-GPo5099vXELht=2wZ8W`kJ=KRC~pRO_>p%(_)sdMqwgBsu&7}=#rr{>kGMcY zI{cqmrOnM58J*hO+cTl+)=j@?^KqF$fR9i-OPX*{vmUZj{>Qp`Qkr!u)4$+GLBqoE z&6Je3wl+{1XJljm2aP}==1tdsVdkS3`T^zZd@q%!#O2Y_NHNhbTC?%xZILLk*wIiF zysOReld=%A|w!lz-e-y_An&4AZehm~9l;BPj@feQs3=_oWQ0#vC zB!R!<6X0!%&}NUz>+5UacY>m#X;a}Ss`hRFdDG(I*{%ufF6lBy1b9aTNe=Wus#L!;CNJuvbA|>68bVzqMjKClz-7O$Fq?B|H%`kL#DKQQ;NTY<(();m! z_kZte@1yVFJNXXgnRU%I*IK{6?|VHln(B(U*p%209z4KRR+7^OzK?+q4D%821otb( zJa|AyqAVw^>tlY9i(yD?&^;t1`N`B@`tbk@jU1!pn`cFz8P4U1!CD*5iq>Rr_zT}k z#>b#PbtKlTw-owZ7^3u)qe-(P)_lssd*9Q#2yx{+Ytl(^E0;!;XNXh*`%%CA_6$WSYrOp0{U-WA{bsqw(fH}WqZ^iI?@?cUv9cTI!WJmBWeI&OS61`CLP3Nv0${o^OdK!w--dA*+U<8quRy5 zSBQ|i5#HR#)RB6MiB8QhG7V-Q8=Y$NxS*9%*V_v#k^eK@nd6V`d9i$19Rta`XnaM< z4@dewj(CJeAV(r)VP3&nVL<*4)j=^H@+jtWY(7`5PH>)^q!40L#(SI!mM)mTF~E{pjNETi-8I8LHr;YrYdsDa9=JLwjGG!})PHGsFsY5Qp9Yb~@?S@}yR| zSh7~#uT``sB#G2!;_kXfmhWD-FKM`I6G3)d-@Q7zVPjK!^Iq&4CSw;UVGcWgo=3~cJhV_Q^QfCdOH=b% zI<;*c)2nAP)O?_#zi!BdPvZ=yg!?QqHE0j~^S3mGv^?scU`NRxiouuPe{k?ks?pRi zl@33lqZD1gmTeE_7UGMxhps@<)8d(IRPCZQYu9KivRJ81uYxW-o>SV}G0`C5bsdfa zH{UaLk4ZQD5>dgfWgJ9w;-1c6V3>cq4LFcoQHxGG+YqTpY_n_P#VgP2;Z-g1H-#ly zgEw8%6BGNYx|IRkXNhkFOYKo)49d=l=BuV~QopN~e9b&Kit82M?ZrlS;eP$N(5c^h z1^b^fp$Lmwsn{rtj0AqZ=7lY9N&d~gQ)z@fQ&E4)%xp>xF0TL|pBo3Qh^XjrI>LV}42C8J|I zjTTQu9ikcr_|oLD6_Ij=x7%c8a1JmPuiYV7Xu)_5fuJy1Xl?l|xDJ28PsrYVpRz3&-7ZvKh) zxwOvtEnOld_d0tQ?i#l4Ebx`CvyiroI0C40i{Ct=%s#26zX3nq$n&>G)UGe-@FhN=l~g1D7j9 z3W4EwN(@ItCZ$wVa0SLP#=$3N0=(yvbdi?Ej_Vh<{vRz4vQMMg;fEsvDXMra=uydi zwV_swK@+p{9cBL3j+7#*Zbtpiiv z1KC;zv;0<(GyLt|f>L-A9-OGI`tgniH&}#51$DR^g=H_X^Rl@3PIPIidXk1|9zQo$*(KOr+%AHKMi208j>U@4e%>VHd%2p zMCIRk>ssF=)^rZ}QY(nFu5EvE=vQj65*psWL*C?EbDFB@y!fKROW3F~>6?m2D=JPt@FG4Ky%f}|h;dc`F9jy<( zenRZ};kgu~_A~N(iGhJ=jytb}^~1lj{W8n5qWBLoyTHn-K*(kTg8Uxe6Bx3xPH*NghX zYa@nE)^*QV9G%!6szeNOlBD%8Vhhv0mVe0|bFRhGC&QLD2IeTyjF2HQ+0kMN3t9Zc z@VXqz`Y7VRcd?h1qxfiUt^6jxrc+C?y&qehd2<*QGu}|*Ezau@5BC+ zVMM+du+@Aeb5}4DHa>c}ocKfHGpxqxoqdP!vm@)@ky^03CALscO=%8?*`={ zM?Z&C7Yr0?6k`>yiNy{H@fVC9gKVa1p!1l`p1EPo7~2lWD>)UT?e1}NGUdqFs#@|I z&$BcK8F^`@Qg%8w5!3xT9r450^!hIhK^{^Kl+w;-WtI}S8vbU!xEdbu&)H4!;_O6q z#SfDv;G7KxMiC;!kP$ex$S+pds{Th$!Mx|KbVl)jYhv!Sojnmv15y}I6T9!%u3lSy z6nReTUuSBAN4$}w#X~^EE+yxC`mp{$Aq#qR=_=Jssf7;KCNb&y0&TS*cUzjc{{PJg6V$>FD_L>TGXzW(H0|vcK3| zrIszYTz>3xaJ)GRk&VVv%jE7|S-Jglw6W}{=FV&&Xu@@TOV=$ITKhT#;ytSAQV(hI zVR=D}Fyml-1wjStMH!@KSz-~4A@-B`|56a%)zt-qoi~D};qy3S`&I1badHX@f(|o`FJDHQXfbzGK^5aEBd_zSs$NN^ z8`PTn`uQ1~n6x;3tI^1pTw7ZM9|#HNB_~^fK+)qiVDQJp%;wq#I0P~aAkJ_CP29*zySH2O6CCmoUQT4a&9IWX zrR8TRlp`!x)YJN#ICeODOiT=2;OW<)cq$RMj+I!FSIf)GUoNL|#eOX`Mh_U&m@X74 z;tON#bhxfP!m_uwPoNgje)FcvZajTg5Q}Y}KH9rk07ZN&P3P(!Bj>(3l8i(m`}+C_ zUMPI-2jlrQ_#CY-wYXgDFAx!p{a)*@$IIb&(7rfaQC3${8fo>|VVgE#K3y`_rpGdu zS{y3q#8+kW#I1N5sgE!{{8#wl&=&L5}n}~`0FTeT|Q zkEe6&K45(TS|5lh76(mH>*(kNJk-R)#C-d;5Phlmu>OoK*@2JIY9LivlN1yNwrU)( zmX~ez36CVsB#R4<=Mwb)kR4J|QbG}4Q^P3*LUs6(i?Q0EYj?w7i!AlW?5y7u zV$KwZmE;(zWNdYOL**vYGx#-4rt>7)J@*hB6s|=BX+x6)ZWGijjjxOmU1RIMAE#Xf zwTHIkK1D`G+M$=J=gLr{2IZX*)eCbKIy?m_wvp133kwTAUSL$mWvBneab*`x$d7s^ zX{%qT&fiHqX!Qa=Q~~;%J@MpHV)M5oY)JHRID=CRjhGjIfJt_3MrLi5u3OBUP{G8b ztuw+7T4felIeook`?eifo4LMQ@E&>QzJc;4rzg^6AaW zreD+xAcl8wy5j%TSZ77x$L1GJAmI0w@rq-fQAd<9IVxp;GS(}OEKRdUjYoThS;sz% zFq3mRCc(~+jzS@u8I7C0$rC0_OiVswy?WALzI;gn8c-N?)l^?E9l_3VxZ0f$frR&s zLYVW#eZ%bdnRLYsl2s$6N!bZq zNOQR(qN6dK2<+SvpjPbS9~p2HRSfCBf1*dWdVn@<2nQRt`=jxdOZ%Qb)t`qWIZR-3 zlmYm`Nx~>RC&IwMz|1EJM<*vQ-2DChg|VuB<5CIs>}^)?h=@>J{ux@2Z)$EH)mF5^ z7wNdKwfRlLpb=3^0iVaky0s&`wJZ6kBz-P=n+cv8a++t$!s&8Kg4K|!7T)B;D?Xg` zie^Hx0O_GcY8%Q|XaD_X_ftR|_i%rMPg-psP0qyd1qISaU!T-m~2eS7ZTVROPy!uHTY3l7XHJL{St z?Yehqn09mNWSQ{1_JM%peT;ziev5x0l>==LY}YMYVWvJnQjK-fU849aR~fP#sC9lJ zC14uQAJ9aq)ZA6YMrfp25c}a=rsA$o8-r_M)g(W*EZAiQ6KmRMizqL8OCX&=%%wv# znH@_t?QtoVrlC+v{wuu_UtR|;mU$D+MH`2&ruQw9$>?8CEr$6O@+AF(Ufgb>s5CO@ z+J#n`1JCoMK)%da+PU{8kACpg@=mgI?KVm?S>Kq|-zK`)Uw18dH-2ZhZTT2aCMd8DYEg#G@Fy5CkFX+zY5Ts{Q4&95+QS>#!w6AOVB;ByHL-@$T-zHKVSguQQX|z5Fc`vVx=C~ zR=Ac~($VFQXK)#)Rbw5)?soEnYs}hV?|;kyFk3IJX=n(y8BPG&s|YPLH1t?+UKJ^z>MM`790KpyNWr%l7C@ z1uc80NHKIVQBik6mMV&B=>19leUtMNVs1{Ck#H@0;);+Iz{H)NP_(a|mnS>zt*!NX zKQ*DyQG3}2j#9u4!Fc?(#VP|X07DXJ#H_V<^o7VNW1*u_sXa&}Ic=qJEdlYO@vInn zBP_}v)fJeXnmSM~&?R2ijJ;G*YHR{bh=xVTi-!)&={Nx6$n=AMjZzG6JR`FR003Tb z4BPvg9vq)5OkG|5fFdV1cfo`aBx_}Njn`O?WJUJ(zeqGH+%>S9$`SEZX&Z}fgl#WT z5*1`*WSEY%YeAuI%(}yfv3HpOje)^n+X_^)xFZPHAq}b9(^2O9eN<=m0LfuZl`Eb3 zGKDi3+(#~Xz27Jqc$EbAoX3q!I}l?}Y{(5;h?kpr^=B=b?u$voojy`eveG$zUht5_ zXQ;>Z_ia-{gN(t}NmYrliA{Y?0yKHZIV+>Z@60j4n!~uMC&RZt3fI?hnh6`kAix~< z>8mDqrNh@F6YE)eu(lC?jh`q<8Cwm$=DK?^rkfW- z-w;Dv1^89Vrlys_f~~LaQd?c!v(*D&_$BpkZraXSS5|>FX@GMwMLd}H-;6m<{q^eX zU$4{<2v^#}KEQlm6|aA?MmtJidl4=k@P`|36g|DAC^j&fq!3(Ysmi_5=IP<;YU#bF zgVc*GhY5U{pEs+se8_4;lW07#40djwD}m1EsOe6~{ZxG{P-L}032$p#zmxB32MVHj z`=I}+s;X)f4n%LfkH0czaD>pwF61PBFj? zd{}sdgg~{NKq38S`)QyTju0abW)ByB7+M)z*1>{KwsBE3xxEXnDR?xZNj_Ry1bO=P ze?nX98T;X5ou#y%4o+tvqC3^pvU532KFSEFUXklRskf#W!*?(DTD1Ziu_~soW~@I8 znii^V%|I46xE%Yl9Dy*z0lL~FTMr#8M*uCZ19~!-r$#&_=co=uh5%`-RPL}x3HW%_ zla!qNa3h`dp`OxnjUdOuDR4@eEmNfzLpjA9!c(PliE_`!kQCzfnNTw_LiBo^8uzbs znrnwjJp%?6Ft^%50sXdi*Ds6P6F81f=;##tpa52i`RsqjqM}J4l7Z0{mafebCOeQj zz?wRQ-z*>>qG_V@81uidP`X8mGTv@2zNsBP3>LHW{~BTuXImR@M2;C1F6}m4Avm2c zH9a{wIWh4uF){Jk<9~j)db|A9G0(5gQ)zKLCVDjiWx>Cubi~*VXx#}X8{*lM(YwK# zuJx~ygAhD2Yv9k77@WZ}GBVcI>v3dU@L<@iaPMnwY8-6YjRgIZxp1h&R3}9}zJ5|` zs8;=6@=(PX{fI)Sv~Q08Bn{Nh(mEUqj(B@xsYy=h-Snx97AyeHiniWj!tsw}*5(U=Z(Y{e zKe{P!a#kjT6sAW}Q>frZJ;7Dl`il?t`2OmP&fRS3OE)wE0r}wP#V4C2|7;C-4foOv zZ)j);2?>#pBW-PM_4VVrs+}2NvZ_Ix#FG1z~&8{b>N7j0r(VgE7znSm@RQK0nWeAf=%eyUo zZlC{8ax)4$&an(+up1Q?71`L?4G!__1)t3uEG{lWjhlG|1YSx9m{8NuECG577>4I~ zubrXTL>DPRCQe2xJEqa$YD{!#_~(YtB0twJxv;b#n!j9Id&S|Iwc(jeyO`@J3#0$d z%$bjY$%Y7yY+PL2hCa7tG7S}#iJ_se^#CR_Gc#cXYjaamscKeAW+vvisIYL7aP=x6 zc>w}WN<#AT<;(hBw~e7r03A=ZClwSF_9@DtY1Z5=1Bj{tuSU7Uvp~CDFXD{WcK?)s zFZMbGyG4m@IIADsUzx=T<}U`!6<2)SgxqWkkj(lrFj)(CCxGLbQi zEhFn@Ee1%Loc_7(*e`mBFBY6IH~0P}9lu2YS?@c@)aPaGmiDQhG*L7IerME-kN)F( z9D!tzGCpro?48ZuwjOR@6s4CIL{%Boy1ya^xR5eHLobRU`1*@$ML&ab`6zp_!Zl~axj*`)tVV0IJ zKTr-mD#VK>t^7{&y>F$T+%pOo3_d#r%_T$YdwOOT1_vWe=+jEe%7mN{`^&8!EWoXc zY%`RPk8jOV^(P6`F6sM1BWNpJ+tF!$S2dZuwxY7RWO=0h&9JWlM8kNuHHRtsN~cE1 zdBJ@A9fe2)wE3!5uJ^5;R#lC~jlnhNlQ`NF4eb|c`bvdj@_ql7VadcJwDIs}r*G-0 zsoymjk}d60($h%^2_KmNBFkor+kI0>{5&}z67~d0cHd7CUS2{we&%l1A1m!b>)waU z(wAp@-!3mNbNI@qqph8sg_K*;N>=pKyD3M^N7t?^i)If?ITnMK^?z-6U8#L)Ipnqs zY$17BTq$36cyOSfa$FW?F8Gc2UBPV8Udp!{NJmxXT}B2E|KZ#Dq9?E?04*5KSt*o{ z1E?OcU~@}LG#A0}h9yvRVqW`j=OsbLq%s9NSkUk94=cGPTAY_irI#_D4H)!IP2pKk ziK}_-exVl@&h&V4cBu)53aA%$SL+5-_(GjI(srl*yzy3OyPF|=r*{x1_Lw6>v{~RG zeu58d<7VIr2(&FKaPqlDNz%@A{>i;h-RIBWzZNOxd~ZK4K(^f)l(faEc#`okM9Rk- z**=deVfm+g6eojxQ7nHnfv0n&p?}_Ab>?ry>iaTMf!X=u_zu#aaH7(#4qdCYscQkd~`JC!v|si^XmNke3us(vORyH?WgQz z%g4tb&w*FQtzi$)D$?QrDfa{H)~d%Bhor~_5h Tsxt7N{DHE(x?GKnW!V1$hx*SQ diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java index eaf04de5bc..7b86e60c4d 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java @@ -39,8 +39,8 @@ import ghidra.util.task.TaskMonitor; *

    * The output defaults to lines of 16-bytes but this is configurable using the * {@link #recordSizeOption} attribute. This allows users to select any record size - * up to the max of 0xFF. Users may also choose to force a record size for every line - * of output, which will only print out lines that match the max record size; any other + * up to the max of 0xFF. Users may also choose to Drop Extra Bytes, which will + * cause only lines that match the max record size to be printed; any other * bytes will be dropped. If this option is not set, every byte will be represented in the output. */ public class IntelHexExporter extends Exporter { @@ -100,8 +100,8 @@ public class IntelHexExporter extends Exporter { /** * Option for exporting Intel Hex records that allows users to specify a record size for the - * output. Users may also optionally specify a force option that will only output - * lines that match this maximum size. + * output. Users may also optionally select the Drop Extra Bytes option that + * will cause only those records that match the maximum size to be output to the file. * * @see RecordSizeComponent */ @@ -140,8 +140,8 @@ public class IntelHexExporter extends Exporter { return Integer.class; } - public boolean getForce() { - return comp.getForce(); + public boolean dropExtraBytes() { + return comp.dropExtraBytes(); } } @@ -151,28 +151,28 @@ public class IntelHexExporter extends Exporter { *

      *
    • input: a {@link HintTextField} for entering numeric digits; these * represent the record size for each line of output
      • - *
    • forceCb: a {@link JCheckBox} for specifying the force setting; this - * enforces that every line in the output matches the specified record size
      • + *
    • dropCb: a {@link JCheckBox} for specifying a setting that enforces that every line in + * the output matches the specified record size
      • *
    * - * Note: If the force option is set, any bytes that are left over after outputting - * all lines that match the record size will be dropped on the floor. + * Note: If the Drop Extra Bytes option is set, any bytes that are left over + * after outputting all lines that match the record size will be omitted from the output. */ private class RecordSizeComponent extends JPanel { private HintTextField input; - private JCheckBox forceCb; + private JCheckBox dropCb; public RecordSizeComponent(int recordSize) { setLayout(new BorderLayout()); input = new HintTextField(String.valueOf(recordSize), false, new BoundedIntegerVerifier()); - forceCb = new JCheckBox("force"); + dropCb = new JCheckBox("Drop Extra Bytes"); input.setText(String.valueOf(recordSize)); add(input, BorderLayout.CENTER); - add(forceCb, BorderLayout.EAST); + add(dropCb, BorderLayout.EAST); } public int getValue() { @@ -184,8 +184,8 @@ public class IntelHexExporter extends Exporter { return Integer.valueOf(val); } - public boolean getForce() { - return forceCb.isSelected(); + public boolean dropExtraBytes() { + return dropCb.isSelected(); } } @@ -276,9 +276,9 @@ public class IntelHexExporter extends Exporter { AddressSetView addrSetView, TaskMonitor monitor) throws MemoryAccessException { int size = (int) recordSizeOption.getValue(); - boolean forceSize = recordSizeOption.getForce(); + boolean dropBytes = recordSizeOption.dropExtraBytes(); - IntelHexRecordWriter writer = new IntelHexRecordWriter(size, forceSize); + IntelHexRecordWriter writer = new IntelHexRecordWriter(size, dropBytes); AddressSet set = new AddressSet(addrSetView); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/IntelHexRecordWriter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/IntelHexRecordWriter.java index 471842790e..16d21698c1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/IntelHexRecordWriter.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/IntelHexRecordWriter.java @@ -22,7 +22,7 @@ import ghidra.program.model.address.*; public class IntelHexRecordWriter { private final int maxBytesPerLine; - private final boolean forceSize; + private final boolean dropExtraBytes; private Address startAddress = null; private Long oldSegment = null; @@ -36,15 +36,15 @@ public class IntelHexRecordWriter { * Constructor * * @param maxBytesPerLine the maximum number of bytes to write per line in the hex output - * @param forceSize if true, only lines matching {@link #maxBytesPerLine} will be output; + * @param dropExtraBytes if true, only lines matching {@link #maxBytesPerLine} will be output; * remaining bytes will be left out */ - public IntelHexRecordWriter(int maxBytesPerLine, boolean forceSize) { + public IntelHexRecordWriter(int maxBytesPerLine, boolean dropExtraBytes) { if (maxBytesPerLine > IntelHexRecord.MAX_RECORD_LENGTH) { throw new IllegalArgumentException("maxBytesPerLine > IntelHexRecord.MAX_RECORD_LENGTH"); } this.maxBytesPerLine = maxBytesPerLine; - this.forceSize = forceSize; + this.dropExtraBytes = dropExtraBytes; } public void addByte(Address address, byte b) { @@ -129,8 +129,9 @@ public class IntelHexRecordWriter { public List finish(Address entryPoint) { // Before finalizing things, write out any remaining bytes that haven't yet been written, if - // the user has specified to do so via the force option (false = write out everything). - if (bytes.size() > 0 && !forceSize) { + // the user has specified to do so via the drop extra bytes option (false = + // write out everything). + if (bytes.size() > 0 && !dropExtraBytes) { emitData(); } From 6c8ee22c07f18bde021ce9365107d174eb9ba85b Mon Sep 17 00:00:00 2001 From: ryanmkurtz Date: Thu, 28 Mar 2019 12:44:27 -0400 Subject: [PATCH 08/35] GT-2702: Fixing spelling. --- .../app/plugin/core/archive/ArchivePlugin.java | 6 +++--- .../java/ghidra/framework/options/OptionsTest.java | 2 +- .../docking/widgets/dialogs/ObjectChooserDialog.java | 2 +- .../java/docking/widgets/table/GTableWidget.java | 2 +- .../src/main/java/docking/widgets/tree/GTree.java | 2 +- .../main/java/ghidra/framework/store/FileSystem.java | 2 +- ...hlightListner.java => PathHighlightListener.java} | 2 +- .../viewer/edge/VisualGraphPathHighlighter.java | 4 ++-- .../java/ghidra/framework/task/gui/GProgressBar.java | 12 ++++++------ 9 files changed, 17 insertions(+), 17 deletions(-) rename Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/{PathHighlightListner.java => PathHighlightListener.java} (95%) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/archive/ArchivePlugin.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/archive/ArchivePlugin.java index 0a30be7cb2..a8d486d338 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/archive/ArchivePlugin.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/archive/ArchivePlugin.java @@ -93,7 +93,7 @@ public class ArchivePlugin extends Plugin implements FrontEndOnly, ProjectListen private volatile boolean isArchiving; private volatile boolean isRestoring; private TaskListener archivingListener; - private TaskListener restoringListner; + private TaskListener restoringListener; ////////////////////////////////////////////////////////////////// @@ -282,7 +282,7 @@ public class ArchivePlugin extends Plugin implements FrontEndOnly, ProjectListen isRestoring = true; - restoringListner = new TaskListener() { + restoringListener = new TaskListener() { @Override public void taskCompleted(Task task) { isRestoring = false; @@ -295,7 +295,7 @@ public class ArchivePlugin extends Plugin implements FrontEndOnly, ProjectListen }; Task task = new RestoreTask(lastRestoreLocator, archiveJar, this); - task.addTaskListener(restoringListner); + task.addTaskListener(restoringListener); new TaskLauncher(task, tool.getToolFrame()); } diff --git a/Ghidra/Features/Base/src/test/java/ghidra/framework/options/OptionsTest.java b/Ghidra/Features/Base/src/test/java/ghidra/framework/options/OptionsTest.java index 6e468ee1e2..792f46f2c9 100644 --- a/Ghidra/Features/Base/src/test/java/ghidra/framework/options/OptionsTest.java +++ b/Ghidra/Features/Base/src/test/java/ghidra/framework/options/OptionsTest.java @@ -623,7 +623,7 @@ public class OptionsTest extends AbstractGenericTest { @Override public int hashCode() { - return 1;// set so that this listener gets called after the storingOptionsListnere + return 1;// set so that this listener gets called after the storingOptionsListener } } diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/ObjectChooserDialog.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/ObjectChooserDialog.java index 0aa754119b..7c9da99b61 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/ObjectChooserDialog.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/dialogs/ObjectChooserDialog.java @@ -63,7 +63,7 @@ public class ObjectChooserDialog extends DialogComponentProvider { table.addSelectionListener(t -> objectSelected(t)); - table.setItemPickListner(t -> objectPicked(t)); + table.setItemPickListener(t -> objectPicked(t)); return table; } diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java index d85f891941..b8a6a2cfb5 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/table/GTableWidget.java @@ -133,7 +133,7 @@ public class GTableWidget extends JPanel { listener.itemPicked(gFilterTable.getSelectedRowObject()); } - public void setItemPickListner(TableItemPickedListener listener) { + public void setItemPickListener(TableItemPickedListener listener) { this.listener = listener; } diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java index 2b60c2e053..ea7c7ee19a 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/GTree.java @@ -867,7 +867,7 @@ public class GTree extends JPanel implements BusyListener { tree.getModel().addTreeModelListener(listener); } - public void removeGTModelListner(TreeModelListener listener) { + public void removeGTModelListener(TreeModelListener listener) { tree.getModel().removeTreeModelListener(listener); } diff --git a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystem.java b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystem.java index 4cfd3fb7aa..6db0208eef 100644 --- a/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystem.java +++ b/Ghidra/Framework/FileSystem/src/main/java/ghidra/framework/store/FileSystem.java @@ -254,7 +254,7 @@ public interface FileSystem { /** * Adds the given listener to be notified of file system changes. - * @param listener the listner to be added. + * @param listener the listener to be added. */ public void addFileSystemListener(FileSystemListener listener); diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/PathHighlightListner.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/PathHighlightListener.java similarity index 95% rename from Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/PathHighlightListner.java rename to Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/PathHighlightListener.java index 68529067a9..366c5dd90f 100644 --- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/PathHighlightListner.java +++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/PathHighlightListener.java @@ -15,7 +15,7 @@ */ package ghidra.graph.viewer.edge; -public interface PathHighlightListner { +public interface PathHighlightListener { /** * Called when the a path is highlighted. diff --git a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/VisualGraphPathHighlighter.java b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/VisualGraphPathHighlighter.java index 0bc45cd701..f6bf916447 100644 --- a/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/VisualGraphPathHighlighter.java +++ b/Ghidra/Framework/Graph/src/main/java/ghidra/graph/viewer/edge/VisualGraphPathHighlighter.java @@ -99,7 +99,7 @@ public class VisualGraphPathHighlighter> postDominanceFuture; private CompletableFuture circuitFuture; - private PathHighlightListner listener = isHover -> { + private PathHighlightListener listener = isHover -> { // stub }; @@ -108,7 +108,7 @@ public class VisualGraphPathHighlighter doUpdateFocusedVertex()); - public VisualGraphPathHighlighter(VisualGraph graph, PathHighlightListner listener) { + public VisualGraphPathHighlighter(VisualGraph graph, PathHighlightListener listener) { this.graph = graph; if (listener != null) { this.listener = listener; diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/gui/GProgressBar.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/gui/GProgressBar.java index 99b316b2e1..29eb284923 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/gui/GProgressBar.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/task/gui/GProgressBar.java @@ -59,12 +59,12 @@ public class GProgressBar extends JPanel { private Timer updateTimer; private EmptyBorderButton cancelButton; - private CancelledListener cancelledListner; + private CancelledListener cancelledListener; - public GProgressBar(CancelledListener cancelledListner, boolean includeTextField, + public GProgressBar(CancelledListener cancelledListener, boolean includeTextField, boolean includeCancelButton, boolean includeAnimatedIcon, float fontSize) { super(new BorderLayout(5, 1)); - this.cancelledListner = cancelledListner; + this.cancelledListener = cancelledListener; this.fontSize = fontSize; buildProgressPanel(includeTextField, includeCancelButton, includeAnimatedIcon); @@ -199,13 +199,13 @@ public class GProgressBar extends JPanel { } public void cancel() { - if (cancelledListner != null) { - cancelledListner.cancelled(); + if (cancelledListener != null) { + cancelledListener.cancelled(); } } public void setCancelledListener(CancelledListener listener) { - this.cancelledListner = listener; + this.cancelledListener = listener; } private void buildProgressPanel(boolean includeTextField, boolean includeCancelButton, From c7afc468c5afb54632c5d2e8bf55f2d141a4eeca Mon Sep 17 00:00:00 2001 From: dragonmacher Date: Wed, 27 Mar 2019 18:03:00 -0400 Subject: [PATCH 09/35] Help - fixed intermittent bug in help build system related to the Dummy help set --- .../location/DirectoryHelpModuleLocation.java | 23 ++----- .../location/JarHelpModuleLocation.java | 66 +++++++++++++++---- 2 files changed, 59 insertions(+), 30 deletions(-) diff --git a/Ghidra/Framework/Help/src/main/java/help/validator/location/DirectoryHelpModuleLocation.java b/Ghidra/Framework/Help/src/main/java/help/validator/location/DirectoryHelpModuleLocation.java index 8c26ca404e..d760e42c65 100644 --- a/Ghidra/Framework/Help/src/main/java/help/validator/location/DirectoryHelpModuleLocation.java +++ b/Ghidra/Framework/Help/src/main/java/help/validator/location/DirectoryHelpModuleLocation.java @@ -16,8 +16,7 @@ package help.validator.location; import java.io.File; -import java.io.IOException; -import java.nio.file.*; +import java.nio.file.Path; import javax.help.HelpSet; @@ -43,21 +42,13 @@ public class DirectoryHelpModuleLocation extends HelpModuleLocation { @Override public GhidraTOCFile loadSourceTOCFile() { - try (DirectoryStream ds = Files.newDirectoryStream(helpDir, "TOC_Source*.xml")) { - for (Path file : ds) { - try { - return GhidraTOCFile.createGhidraTOCFile(file); - } - catch (Exception e) { - throw new AssertException("Unexpected error loading source TOC file!: " + file, - e); - } - } + Path sourceTocPath = helpDir.resolve("TOC_Source.xml"); + try { + return GhidraTOCFile.createGhidraTOCFile(sourceTocPath); } - catch (IOException e) { - throw new AssertException("Error reading help path: " + helpDir); + catch (Exception e) { + throw new AssertException("Unexpected error loading source TOC file!: " + sourceTocPath, + e); } - - throw new AssertException("Help module has no TOC_Source.xml file: " + helpDir); } } diff --git a/Ghidra/Framework/Help/src/main/java/help/validator/location/JarHelpModuleLocation.java b/Ghidra/Framework/Help/src/main/java/help/validator/location/JarHelpModuleLocation.java index 7305787915..7827499dea 100644 --- a/Ghidra/Framework/Help/src/main/java/help/validator/location/JarHelpModuleLocation.java +++ b/Ghidra/Framework/Help/src/main/java/help/validator/location/JarHelpModuleLocation.java @@ -17,11 +17,11 @@ package help.validator.location; import java.io.File; import java.io.IOException; -import java.net.URI; -import java.net.URISyntaxException; +import java.net.*; import java.nio.file.*; import java.util.HashMap; import java.util.Map; +import java.util.regex.Pattern; import javax.help.HelpSet; import javax.help.HelpSetException; @@ -32,6 +32,12 @@ import help.validator.model.GhidraTOCFile; public class JarHelpModuleLocation extends HelpModuleLocation { + /* + * format of 'helpDir': + * jar:file:///.../ghidra-prep/Ghidra/Features/Base/build/libs/Base.jar!/help + */ + private static final Pattern JAR_FILENAME_PATTERN = Pattern.compile(".*/(\\w*)\\.jar!/.*"); + private static Map env = new HashMap(); static { env.put("create", "false"); @@ -69,19 +75,51 @@ public class JarHelpModuleLocation extends HelpModuleLocation { @Override public HelpSet loadHelpSet() { - try (DirectoryStream ds = Files.newDirectoryStream(helpDir, "*_HelpSet.hs");) { - for (Path path : ds) { - return new GHelpSet(null, path.toUri().toURL()); - } - } - catch (IOException e) { - throw new AssertException("No _HelpSet.hs file found for help directory: " + helpDir); - } - catch (HelpSetException e) { - throw new AssertException("Error loading help set for " + helpDir); - } - throw new AssertException("Pre-built help jar file is missing it's help set: " + helpDir); + // Our convention is to name the help set after the module + File jarFile = getJarFile(); + String moduleName = getModuleName(jarFile); + Path hsPath = helpDir.resolve(moduleName + "_HelpSet.hs"); + try { + return new GHelpSet(null, hsPath.toUri().toURL()); + } + catch (MalformedURLException | HelpSetException e) { + throw new AssertException( + "Pre-built help jar file is missing it's help set: " + helpDir, e); + } + } + + private File getJarFile() { + + // format: jar:file:///.../Ghidra/Features//build/libs/.jar!/help + String uriString = helpDir.toUri().toString(); + int start = uriString.indexOf("file:/"); + String chopped = uriString.substring(start); + int end = chopped.indexOf("!"); + chopped = chopped.substring(0, end); + return new File(chopped); + } + + private String getModuleName(File jarFile) { + + String name = jarFile.getName(); + int dotIndex = name.indexOf('.'); + return name.substring(0, dotIndex); + } + + @Override + public Path getHelpModuleLocation() { + // start format: jar:file:///.../Ghidra/Features/Base/build/libs/Base.jar!/help + + // format: file:///.../Ghidra/Features//build/libs/.jar + File jarFile = getJarFile(); + String moduleName = getModuleName(jarFile); + String fullPath = jarFile.getPath(); + int moduleNameStart = fullPath.indexOf(moduleName); + int end = moduleNameStart + moduleName.length(); + String moduleString = fullPath.substring(0, end); + Path modulePath = Paths.get(moduleString); + return modulePath; } @Override From 7caa7e369bf77df272a92a74a559167bb70a46db Mon Sep 17 00:00:00 2001 From: adamopolous Date: Thu, 28 Mar 2019 14:46:21 -0400 Subject: [PATCH 10/35] GT-2703: fixes from code review --- .../ghidra/app/util/exporter/Compare.java | 9 +- .../app/util/exporter/IntelHexExporter.java | 248 ++++++++++-------- 2 files changed, 140 insertions(+), 117 deletions(-) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/Compare.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/Compare.java index 58ba286399..4b2fb28cb5 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/Compare.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/Compare.java @@ -25,17 +25,17 @@ import ghidra.util.Msg; public class Compare { public static void compare(ArrayList expectedList, File actualFile) throws Exception { int index = 0; - BufferedReader reader = new BufferedReader(new FileReader(actualFile)); - + boolean hasFailure = false; - try { + try (BufferedReader reader = new BufferedReader(new FileReader(actualFile))) { int excess = 0; while (true) { String actualLine = reader.readLine(); if (actualLine == null) { break; } + if (index >= expectedList.size()) { ++excess; continue; @@ -73,8 +73,5 @@ public class Compare { Assert.fail("One or more failures--see output for data"); } } - finally { - reader.close(); - } } } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java index 7b86e60c4d..5418555a92 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java @@ -50,14 +50,32 @@ public class IntelHexExporter extends Exporter { /** Option allowing the user to select the number of bytes in each line of output */ protected RecordSizeOption recordSizeOption; - + + private static final int DEFAULT_RECORD_SIZE = 0x10; + /** - * Constructs a new Intel Hex exporter. + * Constructs a new Intel Hex exporter. This will use a record size of 16 (the default) + * and will export ALL bytes in the program or selection (even if the total length + * is not a multiple of 16. */ public IntelHexExporter() { this("Intel Hex", "hex", new HelpLocation("ExporterPlugin", "intel_hex")); } - + + /** + * Constructs a new Intel Hex exporter with a custom record size. + * + * @param recordSize the record size to use when writing to the output file + * @param dropBytes if true, bytes at the end of the file that don't match the specified + * record size will be dropped + */ + public IntelHexExporter(int recordSize, boolean dropBytes) { + this("Intel Hex", "hex", new HelpLocation("ExporterPlugin", "intel_hex")); + recordSizeOption = new RecordSizeOption("Record Size", Integer.class); + recordSizeOption.setRecordSize(recordSize); + recordSizeOption.setDropBytes(dropBytes); + } + /** * Constructor * @@ -82,7 +100,9 @@ public class IntelHexExporter extends Exporter { addressSpaceOption = new Option("Address Space", program.getAddressFactory().getDefaultAddressSpace()); - recordSizeOption = new RecordSizeOption("Record Size", Integer.class); + if (recordSizeOption == null) { + recordSizeOption = new RecordSizeOption("Record Size", Integer.class); + } optionsList.add(addressSpaceOption); optionsList.add(recordSizeOption); @@ -97,98 +117,7 @@ public class IntelHexExporter extends Exporter { recordSizeOption = (RecordSizeOption) options.get(1); } } - - /** - * Option for exporting Intel Hex records that allows users to specify a record size for the - * output. Users may also optionally select the Drop Extra Bytes option that - * will cause only those records that match the maximum size to be output to the file. - * - * @see RecordSizeComponent - */ - private class RecordSizeOption extends Option { - - // Initialize the record size to 16 bytes when showing the option. - private final RecordSizeComponent comp = new RecordSizeComponent(16); - - public RecordSizeOption(String name, Class valueClass) { - super(name, valueClass); - } - - public RecordSizeOption(String name, Class valueClass, Object value, String arg, - String group) { - super(name, valueClass, value, arg, group); - } - - @Override - public Component getCustomEditorComponent() { - return comp; - } - - @Override - public Option copy() { - return new RecordSizeOption(getName(), getValueClass(), getValue(), getArg(), - getGroup()); - } - - @Override - public Object getValue() { - return comp.getValue(); - } - - @Override - public Class getValueClass() { - return Integer.class; - } - - public boolean dropExtraBytes() { - return comp.dropExtraBytes(); - } - } - - /** - * Component that displays two widgets for setting export options: - * - *
      - *
    • input: a {@link HintTextField} for entering numeric digits; these - * represent the record size for each line of output
      • - *
    • dropCb: a {@link JCheckBox} for specifying a setting that enforces that every line in - * the output matches the specified record size
      • - *
    - * - * Note: If the Drop Extra Bytes option is set, any bytes that are left over - * after outputting all lines that match the record size will be omitted from the output. - */ - private class RecordSizeComponent extends JPanel { - - private HintTextField input; - private JCheckBox dropCb; - - public RecordSizeComponent(int recordSize) { - setLayout(new BorderLayout()); - - input = new HintTextField(String.valueOf(recordSize), false, new BoundedIntegerVerifier()); - dropCb = new JCheckBox("Drop Extra Bytes"); - - input.setText(String.valueOf(recordSize)); - - add(input, BorderLayout.CENTER); - add(dropCb, BorderLayout.EAST); - } - - public int getValue() { - String val = input.getText(); - if (!input.isFieldValid()) { - return 0x10; - } - - return Integer.valueOf(val); - } - - public boolean dropExtraBytes() { - return dropCb.isSelected(); - } - } - + /** * Verifier for a {@link HintTextField} that ensures input is a numeric value between * 0 and 0xFF. @@ -202,24 +131,12 @@ public class IntelHexExporter extends Exporter { HintTextField field = (HintTextField) input; String text = field.getText(); - // Strip off any leading "0x" chars if the user has put them there - the - // parseInt method can't handle them. - if (text.startsWith("0x")) { - text = text.substring(2); - } - - // Now try and parse the input; first as hex, then as decimal. - Integer val; + int val; try { - val = Integer.parseInt(text, 16); + val = Integer.decode(text); } catch (NumberFormatException e) { - try { - val = Integer.parseInt(text); - } - catch (NumberFormatException e1) { - return false; - } + return false; } return val <= 0xFF && val >= 0; @@ -308,4 +225,113 @@ public class IntelHexExporter extends Exporter { } return writer.finish(entryPoint); } + + /** + * Option for exporting Intel Hex records that allows users to specify a record size for the + * output. Users may also optionally select the Drop Extra Bytes option that + * will cause only those records that match the maximum size to be output to the file. + * + * @see RecordSizeComponent + */ + private class RecordSizeOption extends Option { + + private final RecordSizeComponent comp = new RecordSizeComponent(DEFAULT_RECORD_SIZE); + + public RecordSizeOption(String name, Class valueClass) { + super(name, valueClass); + } + + public RecordSizeOption(String name, Class valueClass, Object value, String arg, + String group) { + super(name, valueClass, value, arg, group); + } + + @Override + public Component getCustomEditorComponent() { + return comp; + } + + @Override + public Option copy() { + return new RecordSizeOption(getName(), getValueClass(), getValue(), getArg(), + getGroup()); + } + + @Override + public Object getValue() { + return comp.getValue(); + } + + @Override + public Class getValueClass() { + return Integer.class; + } + + public boolean dropExtraBytes() { + return comp.dropExtraBytes(); + } + + public void setRecordSize(int recordSize) { + comp.setRecordSize(recordSize); + } + + public void setDropBytes(boolean dropBytes) { + comp.setDropBytes(dropBytes); + } + } + + /** + * Component that displays two widgets for setting export options: + * + *
      + *
    • input: a {@link HintTextField} for entering numeric digits; these + * represent the record size for each line of output
      • + *
    • dropCb: a {@link JCheckBox} for specifying a setting that enforces that every line in + * the output matches the specified record size
      • + *
    + * + * Note: If the Drop Extra Bytes option is set, any bytes that are left over + * after outputting all lines that match the record size will be omitted from the output. + */ + private class RecordSizeComponent extends JPanel { + + private HintTextField input; + private JCheckBox dropCb; + + public RecordSizeComponent(int recordSize) { + setLayout(new BorderLayout()); + + input = new HintTextField(Integer.toString(recordSize), false, new BoundedIntegerVerifier()); + dropCb = new JCheckBox("Drop Extra Bytes"); + + input.setText(Integer.toString(recordSize)); + + add(input, BorderLayout.CENTER); + add(dropCb, BorderLayout.EAST); + } + + public int getValue() { + String val = input.getText(); + if (!input.isFieldValid()) { + + // If the user clears the input field, revert to the default + // record size (16). + return DEFAULT_RECORD_SIZE; + } + + return Integer.valueOf(val); + } + + public boolean dropExtraBytes() { + return dropCb.isSelected(); + } + + public void setRecordSize(int recordSize) { + input.setText(Integer.toString(recordSize)); + } + + public void setDropBytes(boolean dropBytes) { + dropCb.setSelected(dropBytes); + } + } } From 381e7e9f49f0243d88d64d54e18b307a71c1b603 Mon Sep 17 00:00:00 2001 From: Dan <46821332+nsadeveloper789@users.noreply.github.com> Date: Thu, 28 Mar 2019 16:21:24 -0400 Subject: [PATCH 11/35] Many updates to the Development Guide --- DevGuide.md | 101 ++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 74 insertions(+), 27 deletions(-) diff --git a/DevGuide.md b/DevGuide.md index 8d81f21580..1f13640b7f 100644 --- a/DevGuide.md +++ b/DevGuide.md @@ -1,25 +1,54 @@ -# Developer's Guide: Getting Started +# Developer's Guide + +## Catalog of Dependencies + +The following is a list of dependencies, in no particular order. +This guide includes instructions for obtaining each of these at the relevant step(s). +You may not need all of these, depending on which portions you are building or developing. + +* JDK 11 - We test and build using OpenJDK 11.0.2. +* Eclipse - It must support JDK 11. Eclipse 2018-12 or later should work. Other IDEs may work, but we have not tested them. +* Gradle 5.0 - Later versions may work, but you'll need to modify our version check. +* A C/C++ compiler - We use Visual Studio 2017 on Windows, GCC on Linux, and Xcode (Clang) on macOS. +* Git - We use git-bash on Windows. Most Linux distros have git in their repos. Xcode provides git on macOS. +* Bash - This is moot on Linux and macOS. On Windows, we use MinGW. This may be distributed with Git for Windows. +* Bison and Flex - We use MinGW on Windows. Most Linux distros have these in their reposs. Xcode provides these for macOS. +* dex2jar +* AXMLPrinter2 +* HFS Explorer 0.21 +* Yet Another Java Service Wrapper 12.12 - Only to build Ghidra package. +* Eclipse PDE - Only for the GhidraDev plugin. +* Eclipse CDT 8.6.0 - Only for the GhidraDev plugin +* PyDev 6.3.1 - Only for the GhidraDev plugin + +There are many others automatically downloaded by Gradle from Maven Central and Bintray JCenter when building and/or setting up the development environment. + +## Install Development and Build Tools + +If you're on Windows, install Git. +You may also need to install MinGW. +Many of the commands given below must be executed in Bash. Install OpenJDK 11 and make sure it's the default java. -Install a version of Eclipse with good support for Java 11. -Eclipse 2018-12 or later should work. -Technically, you can launch with any JRE/JDK, but it's up to you ensure OpenJDK 11 is properly configured in Eclipse. +Install Eclipse. +You can launch Eclipse with any JRE/JDK, but you'll need to ensure Eclipse knows about your JDK 11 installation. +In Eclipse, select Window -> Prefereces (Eclipse -> Preferences on macOS), then navigate to Java -> Installed JREs, and ensure a JDK 11 is configured. -Install Gradle 5.0, add it to your `PATH`, and ensure it is launched using OpenJDK 11. -Other versions of Gradle may work, but they have not been tested. +Install Gradle, add it to your `PATH`, and ensure it is launched using JDK 11. -## Setup Repositories +## Setup Source and Dependency Repositories -Of course, you may choose any directory for your working copy, but these instructions will assume you have cloned the repo to `~/git`. +You may choose any directory for your working copy, but these instructions will assume you have cloned the source to `~/git/ghidra`. Be sure to adjust the commands to match your chosen working directory if different than suggested: ```bash +mkdir ~/git cd ~/git git clone git@github.com:NationalSecurityAgency/ghidra.git ``` -Ghidra's build uses artifact named as available in Maven Central and Bintray JCenter, when possible. +Ghidra's build uses artifacts named as available in Maven Central and Bintray JCenter, when possible. Unfortunately, in some cases, the artifact or the particular version we desire is not available. So, in addition to mavenCentral and jcenter, you must configure a flatDir-style repository for manually-downloaded dependencies. @@ -37,7 +66,7 @@ allprojects { } ``` -You should also create the `~/flatRepo` folder to hold the manually-downloaded dependencies: +Create the `~/flatRepo` folder to hold the manually-downloaded dependencies: ```bash mkdir ~/flatRepo @@ -85,13 +114,24 @@ cp csframework.jar hfsx_dmglib.jar hfsx.jar iharder-base64.jar ~/flatRepo/ ## Import Gradle Project If you want just to build Ghidra, you may skip ahead to Building Ghidra. -Import Ghidra into Eclipse using the integrated BuildShip plugin. +Otherwise, import Ghidra into Eclipse using the integrated BuildShip plugin. +Select File -> Import, expand Gradle, and select "Existing Gradle Project." +Select the root of the source repo as the root Gradle project. Be sure to select Gradle 5.0, or point it at your local installation. -Other IDEs should work, but we have not tested with them. You may see build path errors until the environment is properly prepared, as described below. -*Alternatively*, you may have Gradle generate the Eclipse projects (`gradle eclipse`) and import those instead. +*Alternatively*, you may have Gradle generate the Eclipse projects and import those instead. This is the way to go if you'd prefer not to activate Gradle's BuildShip plugin. +From the project root: + +```bash +gradle eclipse +``` + +Select File -> Import, expand General, and select "Existing Projects into Workspace." +Select the root of the source repo, and select "Search for nested projects." +Select all, and Finish. +You may see build path errors until the environment is properly prepared, as described below. ## Prepare the Environment @@ -100,7 +140,7 @@ From the project root, execute: ```bash gradle prepDev -x yajswDevUnpack ``` -The `prepDev` tasks primarily include generating some source, indexing our online help, and unpacking some dependencies. +The `prepDev` tasks primarily include generating some source, indexing our built-in help, and unpacking some dependencies. Regarding `yajswDevUnpack`, please see the relevant sections on GhidraServer below. For now, we exclude the unpack task. @@ -110,7 +150,7 @@ Optionally, to pre-compile all the language modules, you may also execute: gradle sleighCompile ``` -Refresh the Gradle project in Eclipse. +Refresh the projects in Eclipse. You should not see any errors at this point, and you can accomplish many development tasks. However, some features of Ghidra will not be functional until further steps are taken. @@ -118,7 +158,7 @@ However, some features of Ghidra will not be functional until further steps are Some of Ghidra's components are built for the native platform. We currently support Linux, macOS, and Windows 64-bit x86 systems. -Others should be possible, but we do not support them. +Others should be possible, but we do not test on them. #### decompile @@ -139,7 +179,7 @@ gradle decompileOsx64Executable On Windows: ```cmd -gradlew decompileWin64Executable +gradle decompileWin64Executable ``` #### demangler_gnu @@ -160,7 +200,7 @@ gradle demangler_gnuOsx64Executable On Windows: ```cmd -gradlew demangler_gnuWin64Executable +gradle demangler_gnuWin64Executable ``` #### sleigh @@ -184,12 +224,16 @@ gradle sleighOsx64Executable On Windows: ```cmd -gradlew sleighWin64Executable +gradle sleighWin64Executable ``` ## Run Ghidra from Eclipse -To run or debug Ghidra from Eclipse, use the provided launcher. +To run or debug Ghidra from Eclipse, use the provided launch configuration (usually under the "Run" or "Debug" buttons). +If the launcher does not appear, it probably has not been marked as a favorite. +Click the dropdown next to the "Run" button and select "Run Configurations." +Then expand "Java Application" on the left to find the "Ghidra" launcher. + # Building Ghidra @@ -198,9 +242,8 @@ To build the full Ghidra distribution, you must also build the GhidraServer. ## Get Dependencies for GhidraServer Building the GhidraServer requires "Yet another Java service wrapper" (yajsw) version 12.12. -Note that building the full Ghidra package requires building the GhidraServer. Download `yajsw-stable-12.12.zip` from their project on www.sourceforge.net, and place it in a directory named: -`ghidra.bin/Ghidra/Features/GhidraSerer/`: +`ghidra.bin/Ghidra/Features/GhidraSerer/`. Note that `ghidra.bin` must be a sibling of `ghidra`: ```bash cd ~/Downloads # Or wherever @@ -240,9 +283,8 @@ To test it, unzip it where you like, and execute `./ghidraRun`. Some features of Ghidra require the curation of rather extensive data bases. These include the Data Type Archives and Function ID Databases, both of which require collecting header files and libraries for the relevant SDKs and platforms. -Much of this work is done by hand, and the results are simply copied into the build. -We intend to document these procedures as soon as we can. -In the meantime, those artifacts can always be extracted from our binary release. +Much of this work is done by hand. +Until this process is documented, those artifacts can be extracted from an official distribution and combined with your build output. ## Building Data Type Archives @@ -257,15 +299,20 @@ TODO First, install the Eclipse Plugin Development Environment (PDE). By default, the GhidraDev project is excluded from the build. To enable it, uncomment it in `settings.gradle`. + +```bash +${EDITOR:-vi} settings.gradle +``` + You will need some additional runtime dependencies: ## Get Dependencies for GhidraDev Building the GhidraDev plugin for Eclipse requires the CDT and PyDev plugins for Eclipse. Download `cdt-8.6.0.zip` from The Eclipse Foundation, and place it in a directory named: -`ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/`. +`ghidra.bin/GhidraBuild/EclipsePlugins/GhidraDev/buildDependencies/`. Note that `ghidra.bin` must be a sibling of `ghidra`. -To respect the CDT project's resources, you will need to download the file using a browser, or at the very least, locate a suitable mirror on your own: +To respect the Eclipse Project's resources, you may need to download the file using a browser, or at the very least, locate a suitable mirror on your own: ```bash cd ~/Downloads # Or wherever From 56786a9ac00a0ab1c9153f4e5304a212aae5f5fc Mon Sep 17 00:00:00 2001 From: Dan <46821332+nsadeveloper789@users.noreply.github.com> Date: Thu, 28 Mar 2019 18:15:08 -0400 Subject: [PATCH 12/35] A silly typo. --- DevGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DevGuide.md b/DevGuide.md index 1f13640b7f..3fe682a44e 100644 --- a/DevGuide.md +++ b/DevGuide.md @@ -243,7 +243,7 @@ To build the full Ghidra distribution, you must also build the GhidraServer. Building the GhidraServer requires "Yet another Java service wrapper" (yajsw) version 12.12. Download `yajsw-stable-12.12.zip` from their project on www.sourceforge.net, and place it in a directory named: -`ghidra.bin/Ghidra/Features/GhidraSerer/`. Note that `ghidra.bin` must be a sibling of `ghidra`: +`ghidra.bin/Ghidra/Features/GhidraServer/`. Note that `ghidra.bin` must be a sibling of `ghidra`: ```bash cd ~/Downloads # Or wherever From 84c16c2b272ed7e088f74a58dbe0a999b9be663e Mon Sep 17 00:00:00 2001 From: dragonmacher Date: Thu, 28 Mar 2019 18:24:34 -0400 Subject: [PATCH 13/35] GT-2705 - File Import - fixed drag-n-drop onto Project Tree dialogs --- .../foundation/FoundationInitializer.java | 33 +++-- ...hidraFileOpenDataFlavorHandlerService.java | 22 ++- .../app/util/JavaFileListFlavorHandler.java | 48 ------- .../GhidraDataFlavorHandlerService.java | 15 +-- .../main/datatree/JavaFileListHandler.java | 45 +++++-- .../main/datatree/LinuxFileUrlHandler.java | 5 +- .../app/util/FileOpenDataFlavorHandler.java | 12 +- .../FileOpenDataFlavorHandlerService.java | 37 ----- .../ghidra/app/util/FileOpenDropHandler.java | 31 +++-- .../app/util/LocalTreeNodeFlavorHandler.java | 72 ---------- .../util/LocalVersionInfoFlavorHandler.java | 47 ------- .../datatree/DataFlavorHandlerService.java | 38 ------ .../framework/main/datatree/DataTree.java | 126 ++---------------- .../datatree/DataTreeDragNDropHandler.java | 58 +++----- ...andler.java => DataTreeFlavorHandler.java} | 12 +- .../main/datatree/LocalTreeNodeHandler.java | 45 +++++-- .../datatree/LocalVersionInfoHandler.java | 83 +++++++----- .../main/datatree/ProjectDataTreePanel.java | 71 +++------- 18 files changed, 240 insertions(+), 560 deletions(-) delete mode 100644 Ghidra/Features/Base/src/main/java/ghidra/app/util/JavaFileListFlavorHandler.java delete mode 100644 Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDataFlavorHandlerService.java delete mode 100644 Ghidra/Framework/Project/src/main/java/ghidra/app/util/LocalTreeNodeFlavorHandler.java delete mode 100644 Ghidra/Framework/Project/src/main/java/ghidra/app/util/LocalVersionInfoFlavorHandler.java delete mode 100644 Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataFlavorHandlerService.java rename Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/{DataFlavorHandler.java => DataTreeFlavorHandler.java} (69%) diff --git a/Ghidra/Features/Base/src/main/java/foundation/FoundationInitializer.java b/Ghidra/Features/Base/src/main/java/foundation/FoundationInitializer.java index 40a9a6b1ea..2634a143fd 100644 --- a/Ghidra/Features/Base/src/main/java/foundation/FoundationInitializer.java +++ b/Ghidra/Features/Base/src/main/java/foundation/FoundationInitializer.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,21 +15,29 @@ */ package foundation; -import ghidra.app.factory.*; -import ghidra.app.util.*; -import ghidra.framework.*; -import ghidra.framework.data.*; -import ghidra.framework.main.datatree.*; +import ghidra.app.factory.GhidraToolStateFactory; +import ghidra.app.util.GhidraFileOpenDataFlavorHandlerService; +import ghidra.framework.ModuleInitializer; +import ghidra.framework.PluggableServiceRegistry; +import ghidra.framework.data.ToolStateFactory; +import ghidra.framework.main.datatree.GhidraDataFlavorHandlerService; import ghidra.program.database.*; public class FoundationInitializer implements ModuleInitializer { - public void run() { - PluggableServiceRegistry.registerPluggableService( ToolStateFactory.class, new GhidraToolStateFactory() ); - PluggableServiceRegistry.registerPluggableService( DataFlavorHandlerService.class, new GhidraDataFlavorHandlerService() ); - PluggableServiceRegistry.registerPluggableService( FileOpenDataFlavorHandlerService.class, new GhidraFileOpenDataFlavorHandlerService() ); - PluggableServiceRegistry.registerPluggableService( DataTypeArchiveMergeManagerFactory.class, new GhidraDataTypeArchiveMergeManagerFactory() ); - PluggableServiceRegistry.registerPluggableService( ProgramMultiUserMergeManagerFactory.class, new GhidraProgramMultiUserMergeManagerFactory() ); - } + @Override + public void run() { + PluggableServiceRegistry.registerPluggableService(ToolStateFactory.class, + new GhidraToolStateFactory()); + PluggableServiceRegistry.registerPluggableService(GhidraDataFlavorHandlerService.class, + new GhidraDataFlavorHandlerService()); + PluggableServiceRegistry.registerPluggableService( + GhidraFileOpenDataFlavorHandlerService.class, + new GhidraFileOpenDataFlavorHandlerService()); + PluggableServiceRegistry.registerPluggableService(DataTypeArchiveMergeManagerFactory.class, + new GhidraDataTypeArchiveMergeManagerFactory()); + PluggableServiceRegistry.registerPluggableService(ProgramMultiUserMergeManagerFactory.class, + new GhidraProgramMultiUserMergeManagerFactory()); + } @Override public String getName() { diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/GhidraFileOpenDataFlavorHandlerService.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/GhidraFileOpenDataFlavorHandlerService.java index 938be9843d..5302137db7 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/GhidraFileOpenDataFlavorHandlerService.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/GhidraFileOpenDataFlavorHandlerService.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,14 +15,13 @@ */ package ghidra.app.util; -import ghidra.framework.main.datatree.*; - import java.awt.datatransfer.DataFlavor; -public class GhidraFileOpenDataFlavorHandlerService extends FileOpenDataFlavorHandlerService { +import ghidra.framework.main.datatree.*; - @Override - protected void doRegisterDataFlavorHandlers() { +public class GhidraFileOpenDataFlavorHandlerService { + + public GhidraFileOpenDataFlavorHandlerService() { try { DataFlavor linuxFileUrlFlavor = @@ -34,15 +32,15 @@ public class GhidraFileOpenDataFlavorHandlerService extends FileOpenDataFlavorHa // should never happen as it is using java.lang.String } - LocalTreeNodeFlavorHandler localHandler = new LocalTreeNodeFlavorHandler(); + LocalTreeNodeHandler localHandler = new LocalTreeNodeHandler(); FileOpenDropHandler.addDataFlavorHandler(DataTreeDragNDropHandler.localDomainFileFlavor, localHandler); - FileOpenDropHandler.addDataFlavorHandler(VersionInfoTransferable.localVersionInfoFlavor, + FileOpenDropHandler.addDataFlavorHandler(DataTreeDragNDropHandler.localDomainFileTreeFlavor, localHandler); - FileOpenDropHandler.addDataFlavorHandler(DataFlavor.javaFileListFlavor, - new JavaFileListFlavorHandler()); - FileOpenDropHandler.addDataFlavorHandler( - DataTreeDragNDropHandler.localDomainFileTreeFlavor, localHandler); + FileOpenDropHandler.addDataFlavorHandler(VersionInfoTransferable.localVersionInfoFlavor, + new LocalVersionInfoHandler()); + FileOpenDropHandler.addDataFlavorHandler(DataFlavor.javaFileListFlavor, + new JavaFileListHandler()); } } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/JavaFileListFlavorHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/JavaFileListFlavorHandler.java deleted file mode 100644 index 3bf09ff2e5..0000000000 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/JavaFileListFlavorHandler.java +++ /dev/null @@ -1,48 +0,0 @@ -/* ### - * 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. - */ -package ghidra.app.util; - -import java.awt.datatransfer.DataFlavor; -import java.awt.dnd.DropTargetDropEvent; -import java.io.File; -import java.util.List; - -import ghidra.app.services.FileImporterService; -import ghidra.framework.model.DomainFolder; -import ghidra.framework.plugintool.PluginTool; -import util.CollectionUtils; - -final class JavaFileListFlavorHandler implements FileOpenDataFlavorHandler { - @Override - public void handle(PluginTool tool, Object obj, DropTargetDropEvent e, DataFlavor f) { - List files = CollectionUtils.asList((List) obj, File.class); - - FileImporterService im = tool.getService(FileImporterService.class); - if (im == null) { - tool.setStatusInfo("ERROR: Could not get importer service."); - return; - } - - DomainFolder rootFolder = tool.getProject().getProjectData().getRootFolder(); - - if (files.size() == 1 && files.get(0).isFile()) { - im.importFile(rootFolder, files.get(0)); - } - else { - im.importFiles(rootFolder, files); - } - } -} diff --git a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/GhidraDataFlavorHandlerService.java b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/GhidraDataFlavorHandlerService.java index 45967e040a..c17fe17662 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/GhidraDataFlavorHandlerService.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/GhidraDataFlavorHandlerService.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,9 +17,10 @@ package ghidra.framework.main.datatree; import java.awt.datatransfer.DataFlavor; -public class GhidraDataFlavorHandlerService extends DataFlavorHandlerService { - @Override - protected void doRegisterDataFlavorHandlers() { +public class GhidraDataFlavorHandlerService { + + public GhidraDataFlavorHandlerService() { + try { DataFlavor linuxFileUrlFlavor = new DataFlavor("application/x-java-serialized-object;class=java.lang.String"); @@ -31,15 +31,12 @@ public class GhidraDataFlavorHandlerService extends DataFlavorHandlerService { // should never happen as it is using java.lang.String } - final LocalTreeNodeHandler localTreeNodeHandler = new LocalTreeNodeHandler(); + LocalTreeNodeHandler localNodeHandler = new LocalTreeNodeHandler(); DataTreeDragNDropHandler.addActiveDataFlavorHandler( - DataTreeDragNDropHandler.localDomainFileTreeFlavor, localTreeNodeHandler); + DataTreeDragNDropHandler.localDomainFileTreeFlavor, localNodeHandler); DataTreeDragNDropHandler.addActiveDataFlavorHandler(DataFlavor.javaFileListFlavor, new JavaFileListHandler()); DataTreeDragNDropHandler.addActiveDataFlavorHandler( VersionInfoTransferable.localVersionInfoFlavor, new LocalVersionInfoHandler()); - - DataTreeDragNDropHandler.addInactiveDataFlavorHandler( - DataTreeDragNDropHandler.localDomainFileTreeFlavor, localTreeNodeHandler); } } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java index 69c8bb74a5..cf3c03d8a8 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/JavaFileListHandler.java @@ -19,13 +19,15 @@ package ghidra.framework.main.datatree; import java.awt.datatransfer.DataFlavor; +import java.awt.dnd.DropTargetDropEvent; import java.io.File; import java.util.List; import docking.widgets.tree.GTreeNode; import ghidra.app.services.FileImporterService; -import ghidra.framework.main.FrontEndTool; +import ghidra.app.util.FileOpenDataFlavorHandler; import ghidra.framework.model.DomainFolder; +import ghidra.framework.plugintool.PluginTool; import ghidra.util.Msg; import util.CollectionUtils; @@ -33,24 +35,43 @@ import util.CollectionUtils; * A drag-and-drop handler for trees that is specific to List<File>. (see * {@link DataFlavor#javaFileListFlavor}). */ -final class JavaFileListHandler implements DataFlavorHandler { - @Override - public void handle(FrontEndTool tool, DataTree dataTree, GTreeNode destinationNode, - Object transferData, int dropAction) { - DomainFolder folder = getDomainFolder(destinationNode); +public final class JavaFileListHandler implements DataTreeFlavorHandler, FileOpenDataFlavorHandler { - FileImporterService im = tool.getService(FileImporterService.class); - if (im == null) { - Msg.showError(this, dataTree, "Could Not Import", "Could not find importer service"); + @Override + public void handle(PluginTool tool, Object transferData, DropTargetDropEvent e, DataFlavor f) { + + FileImporterService importer = tool.getService(FileImporterService.class); + if (importer == null) { + Msg.showError(this, null, "Could Not Import", "Could not find Importer Service"); return; } - List fileList = CollectionUtils.asList((List) transferData, File.class); + DomainFolder folder = tool.getProject().getProjectData().getRootFolder(); + doImport(importer, folder, transferData); + } + + @Override + public void handle(PluginTool tool, DataTree dataTree, GTreeNode destinationNode, + Object transferData, int dropAction) { + + FileImporterService importer = tool.getService(FileImporterService.class); + if (importer == null) { + Msg.showError(this, dataTree, "Could Not Import", "Could not find Importer Service"); + return; + } + + DomainFolder folder = getDomainFolder(destinationNode); + doImport(importer, folder, transferData); + } + + private void doImport(FileImporterService importer, DomainFolder folder, Object files) { + + List fileList = CollectionUtils.asList((List) files, File.class); if (fileList.size() == 1 && fileList.get(0).isFile()) { - im.importFile(folder, fileList.get(0)); + importer.importFile(folder, fileList.get(0)); } else { - im.importFiles(folder, fileList); + importer.importFiles(folder, fileList); } } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/LinuxFileUrlHandler.java b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/LinuxFileUrlHandler.java index 9c6f1c115b..16a7e690ef 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/LinuxFileUrlHandler.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/datatree/LinuxFileUrlHandler.java @@ -27,7 +27,6 @@ import java.util.function.Function; import docking.widgets.tree.GTreeNode; import ghidra.app.services.FileImporterService; import ghidra.app.util.FileOpenDataFlavorHandler; -import ghidra.framework.main.FrontEndTool; import ghidra.framework.model.DomainFolder; import ghidra.framework.plugintool.PluginTool; import ghidra.framework.plugintool.ServiceProvider; @@ -38,11 +37,11 @@ import ghidra.util.Msg; * duty in that it opens files for DataTrees and for Tools (signaled via the interfaces it * implements). */ -public final class LinuxFileUrlHandler implements DataFlavorHandler, FileOpenDataFlavorHandler { +public final class LinuxFileUrlHandler implements DataTreeFlavorHandler, FileOpenDataFlavorHandler { @Override // This is for the DataFlavorHandler interface for handling node drops in DataTrees - public void handle(FrontEndTool tool, DataTree dataTree, GTreeNode destinationNode, + public void handle(PluginTool tool, DataTree dataTree, GTreeNode destinationNode, Object transferData, int dropAction) { DomainFolder folder = getDomainFolder(destinationNode); diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDataFlavorHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDataFlavorHandler.java index f4bdd441cc..4852c85c39 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDataFlavorHandler.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDataFlavorHandler.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,11 +15,14 @@ */ package ghidra.app.util; -import ghidra.framework.plugintool.*; +import java.awt.datatransfer.DataFlavor; +import java.awt.dnd.DropTargetDropEvent; -import java.awt.datatransfer.*; -import java.awt.dnd.*; +import ghidra.framework.plugintool.PluginTool; +/** + * Interface for classes that will handle drop actions for files dropped onto the tool + */ public interface FileOpenDataFlavorHandler { - public void handle(PluginTool tool, Object obj, DropTargetDropEvent e, DataFlavor f); + public void handle(PluginTool tool, Object obj, DropTargetDropEvent e, DataFlavor f); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDataFlavorHandlerService.java b/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDataFlavorHandlerService.java deleted file mode 100644 index 687e6aed63..0000000000 --- a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDataFlavorHandlerService.java +++ /dev/null @@ -1,37 +0,0 @@ -/* ### - * IP: GHIDRA - * REVIEWED: YES - * - * 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. - */ -package ghidra.app.util; - -import ghidra.framework.PluggableServiceRegistry; -import ghidra.framework.main.datatree.DataTreeDragNDropHandler; -import ghidra.framework.main.datatree.VersionInfoTransferable; - -public class FileOpenDataFlavorHandlerService { - static { - PluggableServiceRegistry.registerPluggableService(FileOpenDataFlavorHandlerService.class, new FileOpenDataFlavorHandlerService()); - } - - public static void registerDataFlavorHandlers() { - FileOpenDataFlavorHandlerService factory = PluggableServiceRegistry.getPluggableService(FileOpenDataFlavorHandlerService.class); - factory.doRegisterDataFlavorHandlers(); - } - - protected void doRegisterDataFlavorHandlers() { - FileOpenDropHandler.addDataFlavorHandler(DataTreeDragNDropHandler.localDomainFileFlavor, new LocalTreeNodeFlavorHandler()); - FileOpenDropHandler.addDataFlavorHandler(VersionInfoTransferable.localVersionInfoFlavor, new LocalTreeNodeFlavorHandler()); - } -} diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDropHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDropHandler.java index 7a16da0504..6a4e4428ce 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDropHandler.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/app/util/FileOpenDropHandler.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,9 +15,6 @@ */ package ghidra.app.util; -import ghidra.framework.plugintool.PluginTool; -import ghidra.util.CascadedDropTarget; - import java.awt.Component; import java.awt.Container; import java.awt.datatransfer.DataFlavor; @@ -33,6 +29,8 @@ import javax.swing.CellRendererPane; import docking.DropTargetHandler; import docking.dnd.DropTgtAdapter; import docking.dnd.Droppable; +import ghidra.framework.plugintool.PluginTool; +import ghidra.util.CascadedDropTarget; /** * Handles drag/drop events on a given component such that a file @@ -44,9 +42,6 @@ import docking.dnd.Droppable; public class FileOpenDropHandler implements DropTargetHandler, Droppable, ContainerListener { private static HashMap handlers = new HashMap(); - static { - FileOpenDataFlavorHandlerService.registerDataFlavorHandlers(); - } private DropTgtAdapter dropTargetAdapter; private DropTarget globalDropTarget; @@ -75,11 +70,13 @@ public class FileOpenDropHandler implements DropTargetHandler, Droppable, Contai /** * Dispose this drop handler. */ + @Override public void dispose() { deinitializeComponents(component); globalDropTarget.removeDropTargetListener(dropTargetAdapter); } + @Override public boolean isDropOk(DropTargetDragEvent e) { Set flavors = handlers.keySet(); for (DataFlavor dataFlavor : flavors) { @@ -90,6 +87,7 @@ public class FileOpenDropHandler implements DropTargetHandler, Droppable, Contai return false; } + @Override public void add(Object obj, DropTargetDropEvent e, DataFlavor f) { FileOpenDataFlavorHandler handler = handlers.get(f); if (handler != null) { @@ -97,24 +95,28 @@ public class FileOpenDropHandler implements DropTargetHandler, Droppable, Contai } } + @Override public void dragUnderFeedback(boolean ok, DropTargetDragEvent e) { // nothing to display or do } + @Override public void undoDragUnderFeedback() { // nothing to display or do } private void initializeComponents(Component comp) { - if (comp instanceof CellRendererPane) + if (comp instanceof CellRendererPane) { return; + } if (comp instanceof Container) { Container c = (Container) comp; c.addContainerListener(this); Component comps[] = c.getComponents(); - for (Component element : comps) + for (Component element : comps) { initializeComponents(element); + } } DropTarget primaryDropTarget = comp.getDropTarget(); if (primaryDropTarget != null) { @@ -123,15 +125,17 @@ public class FileOpenDropHandler implements DropTargetHandler, Droppable, Contai } private void deinitializeComponents(Component comp) { - if (comp instanceof CellRendererPane) + if (comp instanceof CellRendererPane) { return; + } if (comp instanceof Container) { Container c = (Container) comp; c.removeContainerListener(this); Component comps[] = c.getComponents(); - for (Component element : comps) + for (Component element : comps) { deinitializeComponents(element); + } } DropTarget dt = comp.getDropTarget(); if (dt instanceof CascadedDropTarget) { @@ -141,15 +145,18 @@ public class FileOpenDropHandler implements DropTargetHandler, Droppable, Contai } } + @Override public void componentAdded(ContainerEvent e) { initializeComponents(e.getChild()); } + @Override public void componentRemoved(ContainerEvent e) { deinitializeComponents(e.getChild()); } - public static void addDataFlavorHandler(DataFlavor dataFlavor, FileOpenDataFlavorHandler handler) { + public static void addDataFlavorHandler(DataFlavor dataFlavor, + FileOpenDataFlavorHandler handler) { handlers.put(dataFlavor, handler); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/LocalTreeNodeFlavorHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/app/util/LocalTreeNodeFlavorHandler.java deleted file mode 100644 index fe87e5cf59..0000000000 --- a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/LocalTreeNodeFlavorHandler.java +++ /dev/null @@ -1,72 +0,0 @@ -/* ### - * IP: GHIDRA - * REVIEWED: YES - * - * 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. - */ -/** - * - */ -package ghidra.app.util; - -import ghidra.framework.main.GetVersionedObjectTask; -import ghidra.framework.main.datatree.*; -import ghidra.framework.model.*; -import ghidra.framework.plugintool.PluginTool; - -import java.awt.datatransfer.DataFlavor; -import java.awt.dnd.DropTargetDropEvent; -import java.util.List; - -final class LocalTreeNodeFlavorHandler implements FileOpenDataFlavorHandler { - public void handle(PluginTool tool, Object obj, DropTargetDropEvent e, DataFlavor f) { - if (f.equals(DataTreeDragNDropHandler.localDomainFileFlavor)) { - List files = (List) obj; - DomainFile[] domainFiles = new DomainFile[files.size()]; - for (int i = 0; i < files.size(); i++) { - domainFiles[i] = (DomainFile) files.get(i); - } - tool.acceptDomainFiles(domainFiles); - } - else if (f.equals(DataTreeDragNDropHandler.localDomainFileTreeFlavor)) { - List files = (List) obj; - DomainFile[] domainFiles = new DomainFile[files.size()]; - for (int i = 0; i < files.size(); i++) { - DomainFileNode node = (DomainFileNode) files.get(i); - domainFiles[i] = node.getDomainFile(); - } - tool.acceptDomainFiles(domainFiles); - } - else if (f.equals(VersionInfoTransferable.localVersionInfoFlavor)) { - VersionInfo info = (VersionInfo) obj; - Project project = tool.getProject(); - ProjectData projectData = project.getProjectData(); - DomainFile file = projectData.getFile(info.getDomainFilePath()); - DomainObject versionedObj = getVersionedObject(tool, file, info.getVersionNumber()); - - if (versionedObj != null) { - DomainFile domainFile = versionedObj.getDomainFile(); - if (domainFile != null) { - tool.acceptDomainFiles(new DomainFile[] { domainFile }); - } - versionedObj.release(this); - } - } - } - - private DomainObject getVersionedObject(PluginTool tool, DomainFile file, int versionNumber) { - GetVersionedObjectTask task = new GetVersionedObjectTask(this, file, versionNumber); - tool.execute(task, 250); - return task.getVersionedObject(); - } -} diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/LocalVersionInfoFlavorHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/app/util/LocalVersionInfoFlavorHandler.java deleted file mode 100644 index 62d2bd7e75..0000000000 --- a/Ghidra/Framework/Project/src/main/java/ghidra/app/util/LocalVersionInfoFlavorHandler.java +++ /dev/null @@ -1,47 +0,0 @@ -/* ### - * IP: GHIDRA - * REVIEWED: YES - * - * 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. - */ -/** - * - */ -package ghidra.app.util; - -import ghidra.framework.main.*; -import ghidra.framework.main.datatree.*; -import ghidra.framework.model.*; -import ghidra.framework.plugintool.*; - -import java.awt.datatransfer.*; -import java.awt.dnd.*; - -final class LocalVersionInfoFlavorHandler implements - FileOpenDataFlavorHandler { - public void handle(PluginTool tool, Object obj, DropTargetDropEvent e, DataFlavor f) { - VersionInfo info = (VersionInfo) obj; - - DomainFile file = tool.getProject().getProjectData().getFile(info.getDomainFilePath()); - GetVersionedObjectTask task = new GetVersionedObjectTask(this, file, - info.getVersionNumber()); - tool.execute(task, 250); - DomainObject versionedObj = task.getVersionedObject(); - - if (versionedObj != null) { - DomainFile vfile = versionedObj.getDomainFile(); - tool.acceptDomainFiles(new DomainFile[] {vfile}); - versionedObj.release(this); - } - } -} diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataFlavorHandlerService.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataFlavorHandlerService.java deleted file mode 100644 index 3d6bedb22b..0000000000 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataFlavorHandlerService.java +++ /dev/null @@ -1,38 +0,0 @@ -/* ### - * IP: GHIDRA - * REVIEWED: YES - * - * 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. - */ -package ghidra.framework.main.datatree; - -import ghidra.framework.PluggableServiceRegistry; - -public class DataFlavorHandlerService { - static { - PluggableServiceRegistry.registerPluggableService(DataFlavorHandlerService.class, new DataFlavorHandlerService()); - } - - public static void registerDataFlavorHandlers() { - DataFlavorHandlerService factory = PluggableServiceRegistry.getPluggableService(DataFlavorHandlerService.class); - factory.doRegisterDataFlavorHandlers(); - } - - protected void doRegisterDataFlavorHandlers() { - final LocalTreeNodeHandler localTreeNodeHandler = new LocalTreeNodeHandler(); - DataTreeDragNDropHandler.addActiveDataFlavorHandler(DataTreeDragNDropHandler.localDomainFileTreeFlavor, localTreeNodeHandler); - DataTreeDragNDropHandler.addActiveDataFlavorHandler(VersionInfoTransferable.localVersionInfoFlavor, new LocalVersionInfoHandler()); - - DataTreeDragNDropHandler.addInactiveDataFlavorHandler(DataTreeDragNDropHandler.localDomainFileTreeFlavor, localTreeNodeHandler); - } -} diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTree.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTree.java index 513e2aab26..d2e3c8d145 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTree.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTree.java @@ -16,8 +16,7 @@ package ghidra.framework.main.datatree; import java.awt.Component; -import java.awt.event.*; -import java.util.List; +import java.awt.event.KeyEvent; import javax.swing.JTree; import javax.swing.KeyStroke; @@ -30,20 +29,13 @@ import docking.widgets.tree.support.GTreeRenderer; import ghidra.framework.main.FrontEndTool; /** - * Tree that shows the folders and domain files in a Project. + * Tree that shows the folders and domain files in a Project */ public class DataTree extends GTree { - static { - DataFlavorHandlerService.registerDataFlavorHandlers(); - } private boolean isActive; private DataTreeDragNDropHandler dragNDropHandler; - /** - * Constructor - * @param folder root domain folder for the project. - */ DataTree(FrontEndTool tool, GTreeRootNode root) { super(root); @@ -53,30 +45,11 @@ public class DataTree extends GTree { docking.ToolTipManager.sharedInstance().registerComponent(this); - //When the user right clicks, change selection to what the mouse was under - addMouseListener(new MouseAdapter() { - @Override - public void mousePressed(MouseEvent evt) { - if (evt.getButton() == MouseEvent.BUTTON3) { - //Find the would-be newly selected path - TreePath newPath = getPathForLocation(evt.getX(), evt.getY()); - if (newPath == null) { - return; - } - //Determine if the path is already selected--If so, do not change the selection - TreePath[] paths = getSelectionPaths(); - if (paths != null) { - for (TreePath element : paths) { - if (element.equals(newPath)) { - return; - } - } - } - } - } - }); - dragNDropHandler = new DataTreeDragNDropHandler(tool, this, isActive); - setDragNDropHandler(dragNDropHandler); + if (tool != null) { + dragNDropHandler = new DataTreeDragNDropHandler(tool, this, isActive); + setDragNDropHandler(dragNDropHandler); + } + initializeKeyEvents(); } @@ -92,74 +65,10 @@ public class DataTree extends GTree { KeyStroke.getKeyStroke(KeyEvent.VK_X, DockingUtils.CONTROL_KEY_MODIFIER_MASK)); } - void setProjectActive(boolean b) { - dragNDropHandler.setProjectActive(b); - } - - /** - * Return true if this path has all of its subpaths expanded. - */ - public boolean allPathsExpanded(TreePath path) { - - GTreeNode node = (GTreeNode) path.getLastPathComponent(); - if (node.isLeaf()) { - return true; + void setProjectActive(boolean isActive) { + if (dragNDropHandler != null) { + dragNDropHandler.setProjectActive(isActive); } - if (isCollapsed(path)) { - return false; - } - - boolean allLeaves = true; - - List children = node.getChildren(); - for (GTreeNode child : children) { - if (child.isLeaf()) { - continue; - } - allLeaves = false; - if (!isExpanded(child.getTreePath())) { - return false; - } - - if (!allPathsExpanded(child.getTreePath())) { - return false; - } - } - if (allLeaves) { - return isExpanded(path); - } - return true; - } - - /** - * Return true if this path has all of its subpaths collapsed. - */ - public boolean allPathsCollapsed(TreePath path) { - GTreeNode node = (GTreeNode) path.getLastPathComponent(); - - if (isExpanded(path)) { - return false; - } - boolean allLeaves = true; // variable for knowing whether all children are leaves - - node.getChildren(); - for (GTreeNode child : node) { - if (child.isLeaf()) { - continue; - } - allLeaves = false; - if (!isCollapsed(child.getTreePath())) { - return false; - } - - if (!allPathsCollapsed(child.getTreePath())) { - return false; - } - } - if (allLeaves) { - return isCollapsed(path); - } - return true; } public void clearSelection() { @@ -183,20 +92,7 @@ public class DataTree extends GTree { getJTree().stopEditing(); } - ////////////////////////////////////////////////////////////////////// - // *** private methods - ////////////////////////////////////////////////////////////////////// - /** - * Tree cell renderer to use the appropriate icons for the - * DataTreeNodes. - */ private class DataTreeCellRenderer extends GTreeRenderer { - - /** - * Configures the renderer based on the passed in components. - * The icon is set according to value, expanded, and leaf - * parameters. - */ @Override public Component getTreeCellRendererComponent(JTree tree, Object value, boolean sel, boolean expanded, boolean leaf, int row, boolean doesHaveFocus) { @@ -209,7 +105,5 @@ public class DataTree extends GTree { } return this; } - } - } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeDragNDropHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeDragNDropHandler.java index a7b9f32770..70293082f3 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeDragNDropHandler.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeDragNDropHandler.java @@ -30,9 +30,7 @@ import ghidra.util.Msg; import ghidra.util.exception.AssertException; public class DataTreeDragNDropHandler implements GTreeDragNDropHandler { - private static Map activeProjectDropFlavorHandlerMap = - new HashMap<>(); - private static Map inactiveProjectDropFlavorHandlerMap = + private static Map activeProjectDropFlavorHandlerMap = new HashMap<>(); public static DataFlavor localDomainFileTreeFlavor = createLocalTreeNodeFlavor(); public static DataFlavor localDomainFileFlavor = createLocalTreeFlavor(); @@ -79,29 +77,31 @@ public class DataTreeDragNDropHandler implements GTreeDragNDropHandler { public void drop(GTreeNode destination, Transferable transferable, int dropAction) { DataFlavor[] transferDataFlavors = transferable.getTransferDataFlavors(); for (DataFlavor dataFlavor : transferDataFlavors) { - DataFlavorHandler flavorHandler = getFlavorHandler(dataFlavor); + DataTreeFlavorHandler flavorHandler = getFlavorHandler(dataFlavor); if (flavorHandler != null) { - try { - Object transferData = transferable.getTransferData(dataFlavor); - flavorHandler.handle(tool, tree, destination, transferData, dropAction); - } - catch (UnsupportedFlavorException e) { - throw new AssertException( - "Got unsupported flavor from using a supported flavor"); - } - catch (IOException e) { - Msg.showError(this, null, "IO Error", "Error during drop", e); - } + handleDrop(destination, transferable, dropAction, dataFlavor, flavorHandler); return; } } } - private DataFlavorHandler getFlavorHandler(DataFlavor flavor) { - if (isActiveProject) { - return activeProjectDropFlavorHandlerMap.get(flavor); + private void handleDrop(GTreeNode destination, Transferable transferable, int dropAction, + DataFlavor dataFlavor, DataTreeFlavorHandler flavorHandler) { + + try { + Object transferData = transferable.getTransferData(dataFlavor); + flavorHandler.handle(tool, tree, destination, transferData, dropAction); } - return inactiveProjectDropFlavorHandlerMap.get(flavor); + catch (UnsupportedFlavorException e) { + throw new AssertException("Got unsupported flavor from using a supported flavor"); + } + catch (IOException e) { + Msg.showError(this, null, "IO Error", "Error during drop", e); + } + } + + private DataTreeFlavorHandler getFlavorHandler(DataFlavor flavor) { + return activeProjectDropFlavorHandlerMap.get(flavor); } @Override @@ -134,13 +134,6 @@ public class DataTreeDragNDropHandler implements GTreeDragNDropHandler { @Override public DataFlavor[] getSupportedDataFlavors(List transferNodes) { return allSupportedFlavors; -// Set keySet = null; -// if (isActiveProject) { -// keySet = activeProjectDropFlavorHandlerMap.keySet(); -// } else { -// keySet = inactiveProjectDropFlavorHandlerMap.keySet(); -// } -// return keySet.toArray(new DataFlavor[keySet.size()]); } @Override @@ -196,24 +189,15 @@ public class DataTreeDragNDropHandler implements GTreeDragNDropHandler { return false; } - public static void addActiveDataFlavorHandler(DataFlavor flavor, DataFlavorHandler handler) { + public static void addActiveDataFlavorHandler(DataFlavor flavor, DataTreeFlavorHandler handler) { activeProjectDropFlavorHandlerMap.put(flavor, handler); } - public static void addInactiveDataFlavorHandler(DataFlavor flavor, DataFlavorHandler handler) { - inactiveProjectDropFlavorHandlerMap.put(flavor, handler); - } - - public static DataFlavorHandler removeActiveDataFlavorHandler(DataFlavor flavor) { + public static DataTreeFlavorHandler removeActiveDataFlavorHandler(DataFlavor flavor) { return activeProjectDropFlavorHandlerMap.remove(flavor); } - public static DataFlavorHandler removeInctiveDataFlavorHandler(DataFlavor flavor) { - return inactiveProjectDropFlavorHandlerMap.remove(flavor); - } - public void setProjectActive(boolean b) { isActiveProject = b; } - } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataFlavorHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeFlavorHandler.java similarity index 69% rename from Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataFlavorHandler.java rename to Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeFlavorHandler.java index f63e22469c..18aba84d63 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataFlavorHandler.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeFlavorHandler.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,10 +15,13 @@ */ package ghidra.framework.main.datatree; -import ghidra.framework.main.FrontEndTool; import docking.widgets.tree.GTreeNode; +import ghidra.framework.plugintool.PluginTool; -public interface DataFlavorHandler { - public void handle(FrontEndTool tool, DataTree dataTree, GTreeNode destinationNode, - Object transferData, int dropAction); +/** + * Interface for classes that will handle drop actions for {@link DataTree}s. + */ +public interface DataTreeFlavorHandler { + public void handle(PluginTool tool, DataTree dataTree, GTreeNode destinationNode, + Object transferData, int dropAction); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/LocalTreeNodeHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/LocalTreeNodeHandler.java index a31fcc76af..bcc70cdd84 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/LocalTreeNodeHandler.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/LocalTreeNodeHandler.java @@ -15,29 +15,55 @@ */ package ghidra.framework.main.datatree; +import java.awt.datatransfer.DataFlavor; import java.awt.dnd.DnDConstants; +import java.awt.dnd.DropTargetDropEvent; import java.io.IOException; import java.util.List; -import javax.swing.SwingUtilities; - import docking.widgets.tree.GTreeNode; import docking.widgets.tree.GTreeState; -import ghidra.framework.main.FrontEndTool; +import ghidra.app.util.FileOpenDataFlavorHandler; import ghidra.framework.model.DomainFile; import ghidra.framework.model.DomainFolder; +import ghidra.framework.plugintool.PluginTool; import ghidra.util.Msg; +import ghidra.util.SystemUtilities; import ghidra.util.exception.DuplicateFileException; import ghidra.util.exception.FileInUseException; import ghidra.util.task.*; -final class LocalTreeNodeHandler implements DataFlavorHandler { +public final class LocalTreeNodeHandler + implements DataTreeFlavorHandler, FileOpenDataFlavorHandler { + private DataTree dataTree; private GTreeState treeState; + @Override + public void handle(PluginTool tool, Object obj, DropTargetDropEvent e, DataFlavor f) { + + if (f.equals(DataTreeDragNDropHandler.localDomainFileFlavor)) { + List files = (List) obj; + DomainFile[] domainFiles = new DomainFile[files.size()]; + for (int i = 0; i < files.size(); i++) { + domainFiles[i] = (DomainFile) files.get(i); + } + tool.acceptDomainFiles(domainFiles); + } + else if (f.equals(DataTreeDragNDropHandler.localDomainFileTreeFlavor)) { + List files = (List) obj; + DomainFile[] domainFiles = new DomainFile[files.size()]; + for (int i = 0; i < files.size(); i++) { + DomainFileNode node = (DomainFileNode) files.get(i); + domainFiles[i] = node.getDomainFile(); + } + tool.acceptDomainFiles(domainFiles); + } + } + @Override @SuppressWarnings("unchecked") - public void handle(FrontEndTool tool, DataTree tree, GTreeNode destinationNode, + public void handle(PluginTool tool, DataTree tree, GTreeNode destinationNode, Object transferData, int dropAction) { this.dataTree = tree; @@ -52,12 +78,9 @@ final class LocalTreeNodeHandler implements DataFlavorHandler { new TaskLauncher(task, dataTree, 1000); if (treeState != null) { // is set to null if drag results in a task - SwingUtilities.invokeLater(new Runnable() { - @Override - public void run() { - treeState.updateStateForMovedNodes(); - dataTree.restoreTreeState(treeState); - } + SystemUtilities.runSwingLater(() -> { + treeState.updateStateForMovedNodes(); + dataTree.restoreTreeState(treeState); }); } } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/LocalVersionInfoHandler.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/LocalVersionInfoHandler.java index 3dc8e451ec..294f45895d 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/LocalVersionInfoHandler.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/LocalVersionInfoHandler.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -14,42 +13,64 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/** - * - */ package ghidra.framework.main.datatree; -import ghidra.framework.client.*; -import ghidra.framework.main.FrontEndTool; -import ghidra.framework.model.DomainFile; -import ghidra.framework.model.DomainFolder; -import ghidra.util.task.TaskLauncher; - +import java.awt.datatransfer.DataFlavor; +import java.awt.dnd.DropTargetDropEvent; import java.io.IOException; import docking.widgets.tree.GTreeNode; +import ghidra.app.util.FileOpenDataFlavorHandler; +import ghidra.framework.client.*; +import ghidra.framework.main.GetVersionedObjectTask; +import ghidra.framework.model.*; +import ghidra.framework.plugintool.PluginTool; +import ghidra.util.task.TaskLauncher; -final class LocalVersionInfoHandler implements DataFlavorHandler { - public void handle(FrontEndTool tool, DataTree dataTree, GTreeNode destinationNode, - Object transferData, int dropAction) { - DomainFolder folder = getDomainFolder(destinationNode); - - VersionInfo info = (VersionInfo) transferData; - RepositoryAdapter rep = tool.getProject().getProjectData().getRepository(); - try { - if (rep != null) { - rep.connect(); - } - DomainFile file = tool.getProject().getProjectData().getFile(info.getDomainFilePath()); - if (file != null) { - new TaskLauncher(new CopyFileVersionTask(file, info.getVersionNumber(), folder), dataTree, 500); - } - } - catch (NotConnectedException exc) {} - catch (IOException exc) { - ClientUtil.handleException(rep, exc, "Repository Connection", tool.getToolFrame()); - } - } +public final class LocalVersionInfoHandler + implements DataTreeFlavorHandler, FileOpenDataFlavorHandler { + + @Override + public void handle(PluginTool tool, Object obj, DropTargetDropEvent e, DataFlavor f) { + VersionInfo info = (VersionInfo) obj; + + DomainFile file = tool.getProject().getProjectData().getFile(info.getDomainFilePath()); + GetVersionedObjectTask task = + new GetVersionedObjectTask(this, file, info.getVersionNumber()); + tool.execute(task, 250); + DomainObject versionedObj = task.getVersionedObject(); + + if (versionedObj != null) { + DomainFile vfile = versionedObj.getDomainFile(); + tool.acceptDomainFiles(new DomainFile[] { vfile }); + versionedObj.release(this); + } + } + + @Override + public void handle(PluginTool tool, DataTree dataTree, GTreeNode destinationNode, + Object transferData, int dropAction) { + DomainFolder folder = getDomainFolder(destinationNode); + + VersionInfo info = (VersionInfo) transferData; + RepositoryAdapter rep = tool.getProject().getProjectData().getRepository(); + try { + if (rep != null) { + rep.connect(); + } + DomainFile file = tool.getProject().getProjectData().getFile(info.getDomainFilePath()); + if (file != null) { + new TaskLauncher(new CopyFileVersionTask(file, info.getVersionNumber(), folder), + dataTree, 500); + } + } + catch (NotConnectedException exc) { + // not sure why we squash this? + } + catch (IOException exc) { + ClientUtil.handleException(rep, exc, "Repository Connection", tool.getToolFrame()); + } + } private DomainFolder getDomainFolder(GTreeNode destinationNode) { if (destinationNode instanceof DomainFolderNode) { diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreePanel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreePanel.java index 1651798827..4070ac82c0 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreePanel.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreePanel.java @@ -55,33 +55,26 @@ public class ProjectDataTreePanel extends JPanel { private ChangeManager changeMgr; private boolean isActiveProject; - private FrontEndTool tool; // may be null if the panel is inside of the - + // these may be null if the panel is inside of a dialog + private FrontEndTool tool; private FrontEndPlugin plugin; - // data tree dialog - /** - * Construct an empty panel that is going to be used as the active - * panel. - * @param tool front end tool + * Construct an empty panel that is going to be used as the active panel + * @param plugin front end plugin */ public ProjectDataTreePanel(FrontEndPlugin plugin) { this(null, true, plugin, null); } /** - * Construct a new DataTreePanel. + * Constructor + * * @param projectName name of project - * @param projectData object that provides access to all the user data - * folders in a project * @param isActiveProject true if the project is active, and the * data tree may be modified - * @param tool front end tool; will be null if the panel is used in a dialog - * @param actionMgr class to handle enablement of actions; an ActionManager - * is passed in when several data tree panels all need to use the - * same ActionManager, e.g., the viewed projects in the front end tool; - * actionMgr will be null if the panel is used in a dialog + * @param plugin front end plugin; will be null if the panel is used in a dialog + * @param filter optional filter that is used to hide programs from view */ public ProjectDataTreePanel(String projectName, boolean isActiveProject, FrontEndPlugin plugin, DomainFileFilter filter) { @@ -211,9 +204,6 @@ public class ProjectDataTreePanel extends JPanel { } } - /** - * Set the help location for the data tree. - */ public void setHelpLocation(HelpLocation helpLocation) { HelpService help = Help.getHelpService(); help.registerHelp(tree, helpLocation); @@ -228,8 +218,9 @@ public class ProjectDataTreePanel extends JPanel { } /** - * Get the number of selected items in the tree. - * These could be either DomainFile's or DomainFolder's. + * Get the number of selected items in the tree. These could be either files or folders. + * + * @return the number of selected items in the tree. */ public int getSelectedItemCount() { return tree.getSelectionCount(); @@ -279,47 +270,31 @@ public class ProjectDataTreePanel extends JPanel { tree.removeGTreeSelectionListener(l); } - /** - * Add a mouse listener to the data tree. - */ public void addTreeMouseListener(MouseListener l) { tree.addMouseListener(l); } - /** - * Remove the mouse listener from the data tree. - */ public void removeTreeMouseListener(MouseListener l) { tree.removeMouseListener(l); } - /** - * Set the preferred size of the scroll pane that contains the - * data tree. - */ public void setPreferredTreePanelSize(Dimension d) { tree.setPreferredSize(d); } - /** - * Get the project data that this data tree panel is operating on. - */ public ProjectData getProjectData() { return projectData; } /** * Notification that the project was renamed; update the root node name - * and reload the node. + * and reload the node + * @param newName the new project name */ public void projectRenamed(String newName) { updateProjectName(newName); } - /** - * Notification that panel is being disposed. - * - */ public void dispose() { if (projectData != null) { projectData.removeDomainFolderChangeListener(changeMgr); @@ -328,10 +303,12 @@ public class ProjectDataTreePanel extends JPanel { } /** - * Get the data tree node that is selected. - * @param e mouse event for the popup; may be null if this is being - * called as a result of the key binding pressed - * @return null if there is no selection + * Get the data tree node that is selected + * + * @param provider the provider with which to construct the new context + * @param e mouse event for the popup; may be null if this is being called as a result of + * the key binding pressed + * @return the new context; null if there is no selection */ public ActionContext getActionContext(ComponentProvider provider, MouseEvent e) { if (root instanceof NoProjectNode) { @@ -364,9 +341,6 @@ public class ProjectDataTreePanel extends JPanel { domainFolderList, domainFileList, tree, isActiveProject); } - /** - * get the data tree for this data tree panel. - */ public DataTree getDataTree() { return tree; } @@ -380,17 +354,10 @@ public class ProjectDataTreePanel extends JPanel { tree.setFilterVisible(enabled); } - /** - * Return true if this data tree panel is listening to domain folder - * changes. - */ boolean domainFolderListenerAdded() { return changeMgr != null; } - /** - * Get the folder change listener. - */ DomainFolderChangeListener getFolderChangeListener() { return changeMgr; } From f3ef6956c92996e45bf4c67ad4ade13190677d0e Mon Sep 17 00:00:00 2001 From: dragonmacher Date: Thu, 28 Mar 2019 18:25:09 -0400 Subject: [PATCH 14/35] GT-2705 - File Import - review fixes; updated transient project dialogs to not have copy/paste actions etc --- .../core/datamgr/DataTypesActionContext.java | 14 +-- .../ghidra/framework/main/DataTreeDialog.java | 12 +- .../src/main/java/docking/ActionContext.java | 11 +- .../tree/support/GTreeNodeTransferable.java | 119 +++++++++--------- .../datatable/ProjectDataActionContext.java | 17 +++ .../datatable/ProjectDataContextAction.java | 29 ++++- .../ProjectDataContextToggleAction.java | 23 +++- .../ProjectDataTreeContextAction.java | 27 +++- .../main/datatree/DataTreeClipboardUtils.java | 16 +-- .../datatree/DataTreeNodeTransferable.java | 30 ----- .../ProjectDataTreeActionContext.java | 8 +- .../main/datatree/ProjectDataTreePanel.java | 7 +- .../actions/ProjectDataCollapseAction.java | 2 +- .../actions/ProjectDataCopyAction.java | 2 +- .../actions/ProjectDataCutAction.java | 2 +- .../actions/ProjectDataExpandAction.java | 2 +- .../actions/ProjectDataNewFolderAction.java | 6 + .../actions/ProjectDataPasteAction.java | 2 +- .../actions/ProjectDataReadOnlyAction.java | 4 + .../actions/ProjectDataSelectAction.java | 2 +- 20 files changed, 201 insertions(+), 134 deletions(-) delete mode 100644 Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeNodeTransferable.java diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/datamgr/DataTypesActionContext.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/datamgr/DataTypesActionContext.java index 40aed341b9..4b8ebb9d45 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/datamgr/DataTypesActionContext.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/datamgr/DataTypesActionContext.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,6 +15,12 @@ */ package ghidra.app.plugin.core.datamgr; +import java.util.ArrayList; +import java.util.List; + +import javax.swing.tree.TreePath; + +import docking.widgets.tree.GTreeNode; import ghidra.app.context.ProgramActionContext; import ghidra.app.plugin.core.datamgr.archive.ProjectArchive; import ghidra.app.plugin.core.datamgr.tree.DataTypeArchiveGTree; @@ -24,13 +29,6 @@ import ghidra.framework.main.datatable.DomainFileProvider; import ghidra.framework.model.DomainFile; import ghidra.program.model.listing.Program; -import java.util.ArrayList; -import java.util.List; - -import javax.swing.tree.TreePath; - -import docking.widgets.tree.GTreeNode; - public class DataTypesActionContext extends ProgramActionContext implements DomainFileProvider { private final GTreeNode clickedNode; private final boolean isToolbarAction; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/DataTreeDialog.java b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/DataTreeDialog.java index cee3dd427a..526202aadd 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/framework/main/DataTreeDialog.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/framework/main/DataTreeDialog.java @@ -26,6 +26,7 @@ import javax.swing.event.DocumentEvent; import javax.swing.event.DocumentListener; import docking.*; +import docking.event.mouse.GMouseListenerAdapter; import docking.widgets.tree.support.GTreeSelectionEvent; import docking.widgets.tree.support.GTreeSelectionListener; import ghidra.framework.main.datatree.ClearCutAction; @@ -40,7 +41,7 @@ import ghidra.util.layout.PairLayout; * Dialog to open or save domain data items to a new location or name. */ public class DataTreeDialog extends DialogComponentProvider -implements GTreeSelectionListener, ActionListener { + implements GTreeSelectionListener, ActionListener { /** * Dialog type for opening domain data files. @@ -540,10 +541,11 @@ implements GTreeSelectionListener, ActionListener { protected void addTreeListeners() { if (type == OPEN) { - treePanel.addTreeMouseListener(new MouseAdapter() { + + treePanel.addTreeMouseListener(new GMouseListenerAdapter() { @Override - public void mousePressed(MouseEvent e) { - if (e.getClickCount() == 2 && okButton.isEnabled()) { + public void doubleClickTriggered(MouseEvent e) { + if (okButton.isEnabled()) { okCallback(); } } @@ -671,7 +673,7 @@ implements GTreeSelectionListener, ActionListener { // populate the combo box DefaultComboBoxModel model = - (DefaultComboBoxModel) projectComboBox.getModel(); + (DefaultComboBoxModel) projectComboBox.getModel(); model.removeAllElements(); Set map = new HashSet<>(); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/ActionContext.java b/Ghidra/Framework/Docking/src/main/java/docking/ActionContext.java index 3fed77d232..f9d950e63e 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/ActionContext.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/ActionContext.java @@ -47,7 +47,12 @@ public class ActionContext { } /** - * For Testing + * Constructor + * + * @param provider the ComponentProvider that generated this context. + * @param contextObject an optional contextObject that the ComponentProvider can provide + * @param sourceObject an optional source object; this can be anything that actions wish to + * later retrieve */ public ActionContext(ComponentProvider provider, Object contextObject, Object sourceObject) { this(provider, contextObject); @@ -55,8 +60,8 @@ public class ActionContext { } /** - * Returns the {@link #ComponentProvider} that generated this ActionContext - * @return + * Returns the {@link ComponentProvider} that generated this ActionContext + * @return the provider */ public ComponentProvider getComponentProvider() { return provider; diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/support/GTreeNodeTransferable.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/support/GTreeNodeTransferable.java index db434c3374..7a517077b1 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/support/GTreeNodeTransferable.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/tree/support/GTreeNodeTransferable.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,69 +18,75 @@ package docking.widgets.tree.support; import java.awt.datatransfer.*; import java.io.IOException; import java.util.List; +import java.util.Objects; import docking.widgets.tree.GTreeNode; /** - * A transferable for sharing data via drag/drop and clipboard operations for GTrees. + * A transferable for sharing data via drag/drop and clipboard operations for GTrees */ public class GTreeNodeTransferable implements Transferable { - private final List selectedData; - private final GTreeTransferHandler transferHandler; + private final List selectedData; + private final GTreeTransferHandler transferHandler; - /** - * Creates this transferable based upon the selected data and uses the given transfer - * handler to perform {@link Transferable} operations. - * @param handler the handler used to perform transfer operations. - * @param selectedData The - */ - public GTreeNodeTransferable( GTreeTransferHandler handler, List selectedData) { - this.selectedData = selectedData; - this.transferHandler = handler; - } - - /** - * Returns all of the original selected data contained by this transferable. - * @return all of the original selected data contained by this transferable - */ - public List getAllData() { - return selectedData; - } - - /** - * Gets the transfer data from the selection based upon the given flavor. - * @param transferNodes The nodes from which to get the data. - * @param flavor The flavor of data to retreive from the given selection. - * @return the transfer data from the selection based upon the given flavor. - * @throws UnsupportedFlavorException if the given flavor is not one of the supported flavors - * returned by {@link #getSupportedDataFlavors(List)}. - */ - public Object getTransferData(DataFlavor flavor) throws UnsupportedFlavorException, IOException { - return transferHandler.getTransferData(selectedData, flavor); - } - - /** - * Returns the DataFlavors for the types of data that this transferable supports, based upon - * the given selection. - * @param transferNodes The nodes to base the DataFlavor selection upon. - * @return the DataFlavors for the types of data that this transferable supports, based upon - * the given selection. + /** + * Creates this transferable based upon the selected data and uses the given transfer + * handler to perform {@link Transferable} operations + * + * @param handler the handler used to perform transfer operations + * @param selectedData The selected tree nodes */ - public DataFlavor[] getTransferDataFlavors() { - return transferHandler.getSupportedDataFlavors(selectedData); - } + public GTreeNodeTransferable(GTreeTransferHandler handler, List selectedData) { + this.transferHandler = Objects.requireNonNull(handler); + this.selectedData = Objects.requireNonNull(selectedData); + } - /** - * A convenience method to determine if this transferable supports the given flavor. - * @return true if this transferable supports the given flavor. - */ - public boolean isDataFlavorSupported(DataFlavor flavor) { - DataFlavor[] flavors = transferHandler.getSupportedDataFlavors(selectedData); - for(int i=0;i getAllData() { + return selectedData; + } + + /** + * Gets the transfer data from the selection based upon the given flavor + + * @param flavor The flavor of data to retrieve from the given selection. + * @return the transfer data from the selection based upon the given flavor. + * @throws UnsupportedFlavorException if the given flavor is not one of the supported flavors + * returned by {@link #getTransferDataFlavors()} + */ + @Override + public Object getTransferData(DataFlavor flavor) + throws UnsupportedFlavorException, IOException { + return transferHandler.getTransferData(selectedData, flavor); + } + + /** + * Returns the DataFlavors for the types of data that this transferable supports, based upon + * the given selection + * + * @return the DataFlavors for the types of data that this transferable supports, based upon + * the given selection + */ + @Override + public DataFlavor[] getTransferDataFlavors() { + return transferHandler.getSupportedDataFlavors(selectedData); + } + + /** + * A convenience method to determine if this transferable supports the given flavor + * @return true if this transferable supports the given flavor + */ + @Override + public boolean isDataFlavorSupported(DataFlavor flavor) { + DataFlavor[] flavors = transferHandler.getSupportedDataFlavors(selectedData); + for (DataFlavor f : flavors) { + if (f.equals(flavor)) { + return true; + } + } + return false; + } } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataActionContext.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataActionContext.java index 179325b06a..c2acecdda6 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataActionContext.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataActionContext.java @@ -30,6 +30,7 @@ public class ProjectDataActionContext extends ActionContext implements DomainFil private Component comp; private boolean isActiveProject; private ProjectData projectData; + private boolean isTransient; public ProjectDataActionContext(ComponentProvider provider, ProjectData projectData, Object contextObject, List selectedFolders, @@ -112,4 +113,20 @@ public class ProjectDataActionContext extends ActionContext implements DomainFil } return false; } + + /** + * Transient data is that which will appear in a temporary project dialog + * @param isTransient true if transient + */ + public void setTransient(boolean isTransient) { + this.isTransient = isTransient; + } + + /** + * Transient data is that which will appear in a temporary project dialog + * @return true if transient + */ + public boolean isTransient() { + return isTransient; + } } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataContextAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataContextAction.java index 5e9daa17eb..dd853ebb3a 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataContextAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataContextAction.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,20 +25,42 @@ public abstract class ProjectDataContextAction extends DockingAction { } @Override - public final boolean isEnabledForContext(ActionContext actionContext) { + public boolean isEnabledForContext(ActionContext actionContext) { if (!(actionContext instanceof ProjectDataActionContext)) { return false; } + ProjectDataActionContext context = (ProjectDataActionContext) actionContext; + if (ignoreTransientProject(context)) { + return false; + } + return isEnabledForContext(context); } + protected boolean ignoreTransientProject(ProjectDataActionContext context) { + if (supportsTransientProjectData()) { + return false; + } + return context.isTransient(); + } + + /** + * Signals that this action can work on normal project data, as well as transient data. + * Transient data is that which will appear in a temporary project dialog. + * + * @return true if this action works on transient project data + */ + protected boolean supportsTransientProjectData() { + return false; + } + protected boolean isEnabledForContext(ProjectDataActionContext context) { return context.hasOneOrMoreFilesAndFolders(); } @Override - public final void actionPerformed(ActionContext context) { + public void actionPerformed(ActionContext context) { actionPerformed((ProjectDataActionContext) context); } @@ -59,7 +80,7 @@ public abstract class ProjectDataContextAction extends DockingAction { @Override public boolean isAddToPopup(ActionContext context) { - if (!(context instanceof ProjectDataActionContext)) { + if (!isEnabledForContext(context)) { return false; } return isAddToPopup((ProjectDataActionContext) context); diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataContextToggleAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataContextToggleAction.java index d1fcb555f5..2b9dc7b39c 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataContextToggleAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataContextToggleAction.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -30,10 +29,32 @@ public abstract class ProjectDataContextToggleAction extends ToggleDockingAction if (!(actionContext instanceof ProjectDataActionContext)) { return false; } + ProjectDataActionContext context = (ProjectDataActionContext) actionContext; + if (ignoreTransientProject(context)) { + return false; + } + return isEnabledForContext(context); } + protected boolean ignoreTransientProject(ProjectDataActionContext context) { + if (supportsTransientProjectData()) { + return false; + } + return context.isTransient(); + } + + /** + * Signals that this action can work on normal project data, as well as transient data. + * Transient data is that which will appear in a temporary project dialog. + * + * @return true if this action works on transient project data + */ + protected boolean supportsTransientProjectData() { + return false; + } + protected boolean isEnabledForContext(ProjectDataActionContext context) { return context.hasOneOrMoreFilesAndFolders(); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataTreeContextAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataTreeContextAction.java index 137b73986f..7df40012df 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataTreeContextAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataTreeContextAction.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,9 +15,9 @@ */ package ghidra.framework.main.datatable; -import ghidra.framework.main.datatree.ProjectDataTreeActionContext; import docking.ActionContext; import docking.action.DockingAction; +import ghidra.framework.main.datatree.ProjectDataTreeActionContext; public abstract class ProjectDataTreeContextAction extends DockingAction { @@ -31,10 +30,32 @@ public abstract class ProjectDataTreeContextAction extends DockingAction { if (!(actionContext instanceof ProjectDataTreeActionContext)) { return false; } + ProjectDataTreeActionContext context = (ProjectDataTreeActionContext) actionContext; + if (ignoreTransientProject(context)) { + return false; + } + return isEnabledForContext(context); } + protected boolean ignoreTransientProject(ProjectDataActionContext context) { + if (supportsTransientProjectData()) { + return false; + } + return context.isTransient(); + } + + /** + * Signals that this action can work on normal project data, as well as transient data. + * Transient data is that which will appear in a temporary project dialog. + * + * @return true if this action works on transient project data + */ + protected boolean supportsTransientProjectData() { + return false; + } + protected boolean isEnabledForContext(ProjectDataTreeActionContext context) { return context.hasOneOrMoreFilesAndFolders(); } @@ -60,7 +81,7 @@ public abstract class ProjectDataTreeContextAction extends DockingAction { @Override public boolean isAddToPopup(ActionContext context) { - if (!(context instanceof ProjectDataTreeActionContext)) { + if (!isEnabledForContext(context)) { return false; } return isAddToPopup((ProjectDataTreeActionContext) context); diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeClipboardUtils.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeClipboardUtils.java index 40cdb3a720..f522152a2a 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeClipboardUtils.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeClipboardUtils.java @@ -23,6 +23,7 @@ import javax.swing.tree.TreePath; import docking.dnd.GClipboard; import docking.widgets.tree.GTreeNode; +import docking.widgets.tree.support.GTreeNodeTransferable; import ghidra.util.Msg; /** @@ -35,14 +36,8 @@ public class DataTreeClipboardUtils { * Static instance of a callback handler that is notified when the clipboard is changed * and our data is discarded. */ - private static final ClipboardOwner DATATREE_CLIPBOARD_OWNER = new ClipboardOwner() { - @Override - public void lostOwnership(Clipboard clipboard, Transferable contents) { - // This is called when something other than this class modifies the clipboard - // and our data is discarded. - clearCuttables(contents); - } - }; + private static final ClipboardOwner DATATREE_CLIPBOARD_OWNER = + (clipboard, contents) -> clearCuttables(contents); /** * Pushes the GTreeNodes in the specified TreePath array to the clipboard. @@ -59,8 +54,9 @@ public class DataTreeClipboardUtils { GTreeNode node = (GTreeNode) element.getLastPathComponent(); list.add(node); } - DataTreeNodeTransferable contents = - new DataTreeNodeTransferable(tree.getDragNDropHandler(), list); + + GTreeNodeTransferable contents = + new GTreeNodeTransferable(tree.getDragNDropHandler(), list); try { clipboard.setContents(contents, DATATREE_CLIPBOARD_OWNER); diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeNodeTransferable.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeNodeTransferable.java deleted file mode 100644 index 793a178278..0000000000 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/DataTreeNodeTransferable.java +++ /dev/null @@ -1,30 +0,0 @@ -/* ### - * IP: GHIDRA - * REVIEWED: YES - * - * 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. - */ -package ghidra.framework.main.datatree; - -import java.util.List; - -import docking.widgets.tree.GTreeNode; -import docking.widgets.tree.support.GTreeNodeTransferable; -import docking.widgets.tree.support.GTreeTransferHandler; - -public class DataTreeNodeTransferable extends GTreeNodeTransferable { - public DataTreeNodeTransferable(GTreeTransferHandler handler, List selectedData) { - super(handler, selectedData); - } - -} diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreeActionContext.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreeActionContext.java index 63eba46ece..cffbbc0d28 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreeActionContext.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreeActionContext.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,14 +15,13 @@ */ package ghidra.framework.main.datatree; -import ghidra.framework.main.datatable.ProjectDataActionContext; -import ghidra.framework.model.*; - import java.util.List; import javax.swing.tree.TreePath; import docking.ComponentProvider; +import ghidra.framework.main.datatable.ProjectDataActionContext; +import ghidra.framework.model.*; public class ProjectDataTreeActionContext extends ProjectDataActionContext { @@ -52,7 +50,7 @@ public class ProjectDataTreeActionContext extends ProjectDataActionContext { return selectionPaths; } - public DataTree getDataTree() { + public DataTree getTree() { return tree; } } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreePanel.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreePanel.java index 4070ac82c0..a3514f5748 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreePanel.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatree/ProjectDataTreePanel.java @@ -337,8 +337,11 @@ public class ProjectDataTreePanel extends JPanel { } } - return new ProjectDataTreeActionContext(provider, projectData, selectionPaths, - domainFolderList, domainFileList, tree, isActiveProject); + ProjectDataTreeActionContext context = new ProjectDataTreeActionContext(provider, + projectData, selectionPaths, domainFolderList, domainFileList, tree, isActiveProject); + boolean isTransient = tool == null; // null for stand-alone dialog, not the project's tree + context.setTransient(isTransient); + return context; } public DataTree getDataTree() { diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCollapseAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCollapseAction.java index fdec297512..6e60a4ad5b 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCollapseAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCollapseAction.java @@ -33,7 +33,7 @@ public class ProjectDataCollapseAction extends ProjectDataTreeContextAction { @Override protected void actionPerformed(ProjectDataTreeActionContext context) { - DataTree tree = context.getDataTree(); + DataTree tree = context.getTree(); TreePath[] paths = context.getSelectionPaths(); collapse(tree, paths[0]); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCopyAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCopyAction.java index 858fb08888..c1207ec325 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCopyAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCopyAction.java @@ -40,7 +40,7 @@ public class ProjectDataCopyAction extends ProjectDataCopyCutBaseAction { protected void actionPerformed(ProjectDataTreeActionContext context) { TreePath[] paths = adjustSelectionPaths(context.getSelectionPaths()); - DataTreeClipboardUtils.setClipboardContents(context.getDataTree(), paths); + DataTreeClipboardUtils.setClipboardContents(context.getTree(), paths); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCutAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCutAction.java index 9341248252..ee80774d39 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCutAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataCutAction.java @@ -40,7 +40,7 @@ public class ProjectDataCutAction extends ProjectDataCopyCutBaseAction { protected void actionPerformed(ProjectDataTreeActionContext context) { TreePath[] paths = adjustSelectionPaths(context.getSelectionPaths()); - DataTreeClipboardUtils.setClipboardContents(context.getDataTree(), paths); + DataTreeClipboardUtils.setClipboardContents(context.getTree(), paths); markNodesCut(paths); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataExpandAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataExpandAction.java index 393457277e..576ce289c3 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataExpandAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataExpandAction.java @@ -33,7 +33,7 @@ public class ProjectDataExpandAction extends ProjectDataTreeContextAction { @Override protected void actionPerformed(ProjectDataTreeActionContext context) { - DataTree tree = context.getDataTree(); + DataTree tree = context.getTree(); TreePath[] paths = context.getSelectionPaths(); expand(tree, paths[0]); } diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataNewFolderAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataNewFolderAction.java index 2e658cf93d..44d8dddf06 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataNewFolderAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataNewFolderAction.java @@ -41,6 +41,12 @@ public class ProjectDataNewFolderAction extends ProjectDataContextAction { markHelpUnnecessary(); } + @Override + protected boolean supportsTransientProjectData() { + // we allow the user to create new folders even in transient projects + return true; + } + @Override protected void actionPerformed(ProjectDataActionContext context) { createNewFolder(context); diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataPasteAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataPasteAction.java index 9bbaee00c5..5bf29f7245 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataPasteAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataPasteAction.java @@ -44,7 +44,7 @@ public class ProjectDataPasteAction extends ProjectDataCopyCutBaseAction { GTreeNode node = (GTreeNode) context.getContextObject(); DomainFolderNode destNode = getFolderForNode(node); - paste(context.getDataTree(), destNode); + paste(context.getTree(), destNode); } @Override diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataReadOnlyAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataReadOnlyAction.java index b7e8837547..4ca5086dcf 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataReadOnlyAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataReadOnlyAction.java @@ -50,6 +50,10 @@ public class ProjectDataReadOnlyAction extends ProjectDataContextToggleAction { if (context.getFolderCount() != 0 || context.getFileCount() != 1) { return false; } + if (ignoreTransientProject(context)) { + return false; + } + DomainFile domainFile = context.getSelectedFiles().get(0); setSelected(domainFile.isReadOnly()); return true; diff --git a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataSelectAction.java b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataSelectAction.java index f584babf9d..f3fa36668e 100644 --- a/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataSelectAction.java +++ b/Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataSelectAction.java @@ -36,7 +36,7 @@ public class ProjectDataSelectAction extends ProjectDataTreeContextAction { @Override protected void actionPerformed(ProjectDataTreeActionContext context) { - DataTree tree = context.getDataTree(); + DataTree tree = context.getTree(); TreePath[] paths = context.getSelectionPaths(); GTreeNode node = (GTreeNode) paths[0].getLastPathComponent(); selectAllChildren(tree, node); From 95ee5750961a6d63b1deea78c6f6a47fb477f321 Mon Sep 17 00:00:00 2001 From: Ryan Kurtz Date: Fri, 29 Mar 2019 11:21:39 -0400 Subject: [PATCH 15/35] Excluding auto-generated Visual Studio files from build. --- gradleScripts/distribution.gradle | 2 ++ gradleScripts/ip.gradle | 2 ++ 2 files changed, 4 insertions(+) diff --git a/gradleScripts/distribution.gradle b/gradleScripts/distribution.gradle index 84bd24a87c..69df51a986 100644 --- a/gradleScripts/distribution.gradle +++ b/gradleScripts/distribution.gradle @@ -196,6 +196,8 @@ task assembleCommon (type: Copy) { exclude "**/.project" exclude "**/.classpath" exclude "**/delete.me" + exclude "**/.vs/**" + exclude "**/*.vcxproj.user" ///////////////// // GHIDRA PROJECTS diff --git a/gradleScripts/ip.gradle b/gradleScripts/ip.gradle index 1522104e6a..16b0c91b08 100644 --- a/gradleScripts/ip.gradle +++ b/gradleScripts/ip.gradle @@ -122,6 +122,8 @@ def Map> getIpForModule(Project p) { exclude "**/*.sla" exclude "**/.gradle/**" exclude "**/.settings/**" + exclude "**/.vs/**" + exclude "**/*.vcxproj.user" } tree.each { file -> String ip = getIp(p.projectDir, file) From 3510e5e5ae98926e70891180167d2ef8edb57318 Mon Sep 17 00:00:00 2001 From: Ryan Kurtz Date: Fri, 29 Mar 2019 11:24:20 -0400 Subject: [PATCH 16/35] Updating Ghidra version number. --- Ghidra/application.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Ghidra/application.properties b/Ghidra/application.properties index d257c4f66c..ad0836e18a 100644 --- a/Ghidra/application.properties +++ b/Ghidra/application.properties @@ -1,5 +1,5 @@ application.name=Ghidra -application.version=9.0.1 +application.version=9.0.2-DEV application.release.name=PUBLIC application.layout.version=1 application.gradle.version=5.0 From 47430356fc7cfe8abb07a645f47f50c98c8c40c2 Mon Sep 17 00:00:00 2001 From: Ryan Kurtz Date: Fri, 29 Mar 2019 11:25:47 -0400 Subject: [PATCH 17/35] Updating Ghidra version number. --- Ghidra/application.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Ghidra/application.properties b/Ghidra/application.properties index d257c4f66c..f85257a265 100644 --- a/Ghidra/application.properties +++ b/Ghidra/application.properties @@ -1,5 +1,5 @@ application.name=Ghidra -application.version=9.0.1 +application.version=9.1-DEV application.release.name=PUBLIC application.layout.version=1 application.gradle.version=5.0 From cf8af653544c11d0a78e661baa35474fda0de93a Mon Sep 17 00:00:00 2001 From: ghidra1 Date: Thu, 28 Mar 2019 17:23:24 -0400 Subject: [PATCH 18/35] GT-2717: Corrected ghidraSvr.bat problems, and avoiding 8.3 filename hack. --- .../Windows/server/ghidraSvr.bat | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/Ghidra/RuntimeScripts/Windows/server/ghidraSvr.bat b/Ghidra/RuntimeScripts/Windows/server/ghidraSvr.bat index 26633759bb..98a2bc2310 100644 --- a/Ghidra/RuntimeScripts/Windows/server/ghidraSvr.bat +++ b/Ghidra/RuntimeScripts/Windows/server/ghidraSvr.bat @@ -11,7 +11,7 @@ rem runtime which has been configured into the system PATH ahead of other Java rem it may be necessary to explicitly specify the path to the installation by setting JAVA_HOME rem below: -rem JAVA_HOME= +rem set JAVA_HOME= setlocal enabledelayedexpansion @@ -94,7 +94,7 @@ if not exist "%WRAPPER_HOME%\" ( echo Using service wrapper: %WRAPPER_DIRNAME% -@rem Find java.exe +rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA=java.exe @@ -105,28 +105,23 @@ goto reportError :findJavaFromJavaHome set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe +set JAVA=%JAVA_HOME%\bin\java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA%" goto lab2 set ERROR=ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% goto reportError :lab2 -:: Make sure some kind of java is on the path. It's required to run the LaunchSupport program. -java -version >nul 2>nul -if not %ERRORLEVEL% == 0 ( - set ERROR=Java runtime not found. Please refer to the Ghidra Installation Guide's Troubleshooting section. - goto reportError -) - :: Get the java that will be used to launch GhidraServer set JAVA_HOME= -for /f "delims=*" %%i in ('java -cp "%LS_CPATH%" LaunchSupport "%GHIDRA_HOME%" -java_home') do set JAVA_HOME=%%i +for /f "delims=*" %%i in ('call "%JAVA%" -cp "%LS_CPATH%" LaunchSupport "%GHIDRA_HOME%" -java_home') do set JAVA_HOME=%%i if "%JAVA_HOME%" == "" ( set ERROR=Failed to find a supported Java runtime. Please refer to the Ghidra Installation Guide's Troubleshooting section. goto reportError ) + +rem reestablish JAVA path based upon final JAVA_HOME set JAVA=%JAVA_HOME%\bin\java.exe set OS_NAME=win32 From e75c28afd679fcb4587fe3e1c8735a41e48b567e Mon Sep 17 00:00:00 2001 From: ghidra5 Date: Fri, 29 Mar 2019 14:39:40 -0400 Subject: [PATCH 19/35] GT-2706 Fixed exceptions in Diff View --- .../java/ghidra/program/util/DiffUtility.java | 32 +++++++++++-------- .../program/util/ProgramDiffDetails.java | 2 +- .../plugin/core/diff/ProgramDiffPlugin.java | 28 +++++++++++----- 3 files changed, 39 insertions(+), 23 deletions(-) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/DiffUtility.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/DiffUtility.java index 7b4d9cbf4d..8d8c87e32a 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/DiffUtility.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/DiffUtility.java @@ -193,11 +193,11 @@ public class DiffUtility extends SimpleDiffUtility { return otherProgram.getSymbolTable().createExternalLibrary(namespace.getName(), source); } else if (namespace instanceof GhidraClass) { - return otherProgram.getSymbolTable().createClass(otherParentNamespace, - namespace.getName(), source); + return otherProgram.getSymbolTable() + .createClass(otherParentNamespace, namespace.getName(), source); } - return otherProgram.getSymbolTable().createNameSpace(otherParentNamespace, - namespace.getName(), source); + return otherProgram.getSymbolTable() + .createNameSpace(otherParentNamespace, namespace.getName(), source); } // /** @@ -329,11 +329,11 @@ public class DiffUtility extends SimpleDiffUtility { if (toAddr == null) { return null; } - return otherProgram.getReferenceManager().getReference(fromAddr, toAddr, - ref.getOperandIndex()); + return otherProgram.getReferenceManager() + .getReference(fromAddr, toAddr, ref.getOperandIndex()); } - Reference otherRef = otherProgram.getReferenceManager().getPrimaryReferenceFrom(fromAddr, - ref.getOperandIndex()); + Reference otherRef = otherProgram.getReferenceManager() + .getPrimaryReferenceFrom(fromAddr, ref.getOperandIndex()); if (otherRef != null && ref.getToAddress().hasSameAddressSpace(otherRef.getToAddress())) { return otherRef; } @@ -357,11 +357,11 @@ public class DiffUtility extends SimpleDiffUtility { if (toAddr1 == null) { return null; } - return program.getReferenceManager().getReference(fromAddr1, toAddr1, - p2Ref.getOperandIndex()); + return program.getReferenceManager() + .getReference(fromAddr1, toAddr1, p2Ref.getOperandIndex()); } - Reference p1Ref = program.getReferenceManager().getPrimaryReferenceFrom(fromAddr1, - p2Ref.getOperandIndex()); + Reference p1Ref = program.getReferenceManager() + .getPrimaryReferenceFrom(fromAddr1, p2Ref.getOperandIndex()); if (p1Ref != null && p1Ref.getToAddress().hasSameAddressSpace(p2Ref.getToAddress())) { return p1Ref; } @@ -385,8 +385,9 @@ public class DiffUtility extends SimpleDiffUtility { otherAddr = getCompatibleAddress(program, addr, otherProgram); } // FIXME Should this be passing the Namespace? - return otherProgram.getExternalManager().addExtLocation(extLoc.getLibraryName(), - extLoc.getLabel(), otherAddr, extLoc.getSource()); + return otherProgram.getExternalManager() + .addExtLocation(extLoc.getLibraryName(), extLoc.getLabel(), otherAddr, + extLoc.getSource()); } /** @@ -707,6 +708,9 @@ public class DiffUtility extends SimpleDiffUtility { Address refAddress = getCompatibleAddress(program, location.refAddr, otherProgram); if (address != null) { + if (byteAddress == null) { + byteAddress = address; // Make sure the byte address isn't null. + } ProgramLocation otherLocation = new ProgramLocation(otherProgram, address, byteAddress, location.getComponentPath(), refAddress, 0, 0, 0); return otherLocation; diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiffDetails.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiffDetails.java index d0cb2dfefd..751d08d165 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiffDetails.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/ProgramDiffDetails.java @@ -2555,7 +2555,7 @@ public class ProgramDiffDetails { } private void addColorAddress(StyledDocument doc, Address addr) { - String text = addr.toString(); + String text = (addr != null) ? addr.toString() : "no matching address"; color(ADDRESS_COLOR); try { doc.insertString(doc.getLength(), text, textAttrSet); diff --git a/Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/ProgramDiffPlugin.java b/Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/ProgramDiffPlugin.java index 9240662b1a..04183ab7cd 100644 --- a/Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/ProgramDiffPlugin.java +++ b/Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/ProgramDiffPlugin.java @@ -441,6 +441,9 @@ public class ProgramDiffPlugin extends ProgramPlugin Address primaryByteAddr = SimpleDiffUtility.getCompatibleAddress(secondaryDiffProgram, byteAddr, primaryProgram); + if (primaryByteAddr == null) { + primaryByteAddr = primaryAddr; // Make sure the byte address isn't null. + } Address primaryRefAddr = SimpleDiffUtility.getCompatibleAddress(secondaryDiffProgram, refAddr, primaryProgram); ProgramLocation newP1Location = new ProgramLocation(primaryProgram, primaryAddr, @@ -463,7 +466,9 @@ public class ProgramDiffPlugin extends ProgramPlugin } ProgramLocation previousP1LocationAsP2 = DiffUtility .getCompatibleProgramLocation(primaryProgram, location, secondaryDiffProgram); - diffListingPanel.setCursorPosition(previousP1LocationAsP2); + if (previousP1LocationAsP2 != null) { + diffListingPanel.setCursorPosition(previousP1LocationAsP2); + } if (diffDetailsProvider != null && diffDetails != null) { diffDetailsProvider.locationChanged(previousP1Location); } @@ -749,7 +754,7 @@ public class ProgramDiffPlugin extends ProgramPlugin runSwing(() -> { MarkerSet selectionMarkers = getSelectionMarkers(); selectionMarkers.clearAll(); - selectionMarkers.add(p2SelectionAsP1); + selectionMarkers.add(p2Selection); }); diffListingPanel.setSelection(p2SelectionAsP1); @@ -798,9 +803,9 @@ public class ProgramDiffPlugin extends ProgramPlugin // Limit the apply to the selection in the view. AddressSet p2SelectionAsP1 = DiffUtility.getCompatibleAddressSet(p2Selection, primaryProgram); - AddressSet p1ApplySet = - p2SelectionAsP1.intersect(p1ViewAddrSet).subtract(addressesOnlyInP1).subtract( - compatibleOnlyInP2); + AddressSet p1ApplySet = p2SelectionAsP1.intersect(p1ViewAddrSet) + .subtract(addressesOnlyInP1) + .subtract(compatibleOnlyInP2); if (p1ApplySet.isEmpty()) { Msg.showInfo(getClass(), tool.getToolFrame(), "Apply Differences", (p2Selection.isEmpty()) ? "No diff selection in the current view." @@ -860,7 +865,7 @@ public class ProgramDiffPlugin extends ProgramPlugin // Right side markers need p1 addresses since they use p1 indexMap. MarkerSet diffMarkers = getDiffMarkers(); // Get right side markers for program 2. diffMarkers.clearAll(); - diffMarkers.add(p2DiffSetAsP1); + diffMarkers.add(p2DiffSet); MarkerSet codeViewerDiffMarkers = getCodeViewerMarkers(); // Get left side markers for program 1. codeViewerDiffMarkers.clearAll(); @@ -884,7 +889,7 @@ public class ProgramDiffPlugin extends ProgramPlugin AddressSet p1DiffHighlightSet = DiffUtility.getCompatibleAddressSet(p2Highlight, primaryProgram); p2DiffHighlight = p2Highlight; - diffMarkers.add(p1DiffHighlightSet); + diffMarkers.add(p2Highlight); codeViewerDiffMarkers.add(p1DiffHighlightSet); } @@ -1603,7 +1608,14 @@ public class ProgramDiffPlugin extends ProgramPlugin diffListingPanel.goTo(currentLocation); MarkerSet cursorMarkers = getCursorMarkers(); - cursorMarkers.setAddressSet(new AddressSet(currentLocation.getAddress())); + Address currentP2Address = currentLocation.getAddress(); + if (currentLocation.getProgram() != secondaryDiffProgram) { // Make sure address is from P2. + currentP2Address = SimpleDiffUtility.getCompatibleAddress(currentLocation.getProgram(), + currentLocation.getAddress(), secondaryDiffProgram); + } + if (currentP2Address != null) { + cursorMarkers.setAddressSet(new AddressSet(currentP2Address)); + } updatePgm2Enablement(); From 9edd697171f88c12fef72fd23e3c51cf25a40835 Mon Sep 17 00:00:00 2001 From: ghidra1 Date: Fri, 29 Mar 2019 16:40:15 -0400 Subject: [PATCH 20/35] GT-2718, Issue#30 corrected PDB DIA SDK error handling, VS post-build syntax and documentation --- Ghidra/Features/PDB/src/global/docs/README_PDB.html | 8 ++++---- .../java/ghidra/app/util/bin/format/pdb/PdbParserNEW.java | 3 +++ Ghidra/Features/PDB/src/pdb/cpp/err.cpp | 5 +---- Ghidra/Features/PDB/src/pdb/cpp/pdb.cpp | 5 ++--- Ghidra/Features/PDB/src/pdb/pdb.vcxproj | 4 ++-- 5 files changed, 12 insertions(+), 13 deletions(-) diff --git a/Ghidra/Features/PDB/src/global/docs/README_PDB.html b/Ghidra/Features/PDB/src/global/docs/README_PDB.html index 7fff3b07c6..3b39a8ef11 100644 --- a/Ghidra/Features/PDB/src/global/docs/README_PDB.html +++ b/Ghidra/Features/PDB/src/global/docs/README_PDB.html @@ -75,9 +75,9 @@ of Visual Studio and DIA SDK.

    First, check to see if you already have the msdia140.dll library installed on your system. It is generally installed installed with Microsoft Visual Studio 2017 when C/C++ development support -is included. +is included ( may be Community, Professional, or other VS 2017 distribution package name). 

    -        C:\\Program Files (x86)\Microsoft Visual Studio\2017\DIA SDK\bin\amd64\msdia140.dll
+        C:\Program Files (x86)\Microsoft Visual Studio\2017\\DIA SDK\bin\amd64\msdia140.dll

    This file is commonly located here, although it may be installed in other locations as well. Any 64-bit copy may be registered provided it is the correct version. There is no need to register more than @@ -86,8 +86,8 @@ one.

    Register 'msdia140.dll' in the Windows registry

    Please register 64-bit msdia140.dll even if you already had a copy of it on your computer -since it is not registered by the Visual Studio installation process. You will need administrative rights/privileges in order to register the DLL in the Windows -registry. +since it is not registered by the Visual Studio installation process. You will need administrative +rights/privileges in order to register the DLL in the Windows registry.

    1. Start a command prompt as an administrator:
      2. diff --git a/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb/PdbParserNEW.java b/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb/PdbParserNEW.java index 9a446da18d..6adbba1967 100644 --- a/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb/PdbParserNEW.java +++ b/Ghidra/Features/PDB/src/main/java/ghidra/app/util/bin/format/pdb/PdbParserNEW.java @@ -576,6 +576,9 @@ public class PdbParserNEW { } catch (Exception e) { if (!isXML) { + if (hasErrors()) { + throw new PdbException(getErrorAndWarningMessages()); + } throw new PdbException("PDB Execution failure of " + PDB_EXE + ".\n" + "This was likely caused by severe execution failure which can occur if executed\n" + "on an unsupported platform. It may be neccessary to rebuild the PDB executable\n" + diff --git a/Ghidra/Features/PDB/src/pdb/cpp/err.cpp b/Ghidra/Features/PDB/src/pdb/cpp/err.cpp index 47bc2d14f1..bf22cc23bf 100644 --- a/Ghidra/Features/PDB/src/pdb/cpp/err.cpp +++ b/Ghidra/Features/PDB/src/pdb/cpp/err.cpp @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,9 +25,7 @@ void warning( const char * msg ) void fatal( const char * msg ) { - fprintf( stderr, "ERROR:\n" ); - fprintf( stderr, msg ); - fprintf( stderr, "\n" ); + fprintf( stderr, "ERROR: %s\n", msg ); exit( -1 ); } diff --git a/Ghidra/Features/PDB/src/pdb/cpp/pdb.cpp b/Ghidra/Features/PDB/src/pdb/cpp/pdb.cpp index 4aedf4c8c6..b08daa7b14 100644 --- a/Ghidra/Features/PDB/src/pdb/cpp/pdb.cpp +++ b/Ghidra/Features/PDB/src/pdb/cpp/pdb.cpp @@ -46,9 +46,8 @@ int init(const char * szFilename, const char * szSignature, const char * szAge) if (hr < 0) { switch (hr) { case REGDB_E_CLASSNOTREG: - fatal("Unable to locate the DIA SDK. It is required to load PDB files.\n\n" \ - "* Open {Ghidra install root}/docs/README_PDB.html\n" - " and follow the instructions therein.\n"); + fatal("Unable to locate the DIA SDK. It is required to load PDB files.\n" \ + "* See docs/README_PDB.html for DLL registration instructions.\n"); break; default: char msg[256]; diff --git a/Ghidra/Features/PDB/src/pdb/pdb.vcxproj b/Ghidra/Features/PDB/src/pdb/pdb.vcxproj index 002c8a5723..500065d27c 100644 --- a/Ghidra/Features/PDB/src/pdb/pdb.vcxproj +++ b/Ghidra/Features/PDB/src/pdb/pdb.vcxproj @@ -72,7 +72,7 @@ rem copy /y /v /b "$(VSInstallDir)DIA SDK\bin\amd64\msdia*.dll" "$(OutDir)" -set OS_DIR="$(SolutionDir)..\..\os" +set OS_DIR=$(SolutionDir)..\..\os if exist "%OS_DIR%\win64" ( mkdir "%OS_DIR%" mkdir "%OS_DIR%\win64" @@ -104,7 +104,7 @@ if exist "%OS_DIR%\win64" ( rem copy /y /v /b "$(VSInstallDir)DIA SDK\bin\amd64\msdia*.dll" "$(OutDir)" -set OS_DIR="$(SolutionDir)..\..\os" +set OS_DIR=$(SolutionDir)..\..\os if exist "%OS_DIR%\win64" ( mkdir "%OS_DIR%" mkdir "%OS_DIR%\win64" From 65ed72ab0ee3a1515e9f39e5c1c84a6d52a4ebbc Mon Sep 17 00:00:00 2001 From: dev747368 <48332326+dev747368@users.noreply.github.com> Date: Fri, 29 Mar 2019 17:18:20 -0400 Subject: [PATCH 21/35] Fix exception when MyProgramChangesDisplayPlugin is uninstalled. --- .../app/plugin/core/misc/MyProgramChangesDisplayPlugin.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/misc/MyProgramChangesDisplayPlugin.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/misc/MyProgramChangesDisplayPlugin.java index fa44fde9b8..897fa89840 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/misc/MyProgramChangesDisplayPlugin.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/misc/MyProgramChangesDisplayPlugin.java @@ -242,6 +242,10 @@ public class MyProgramChangesDisplayPlugin extends ProgramPlugin implements Doma public void dispose() { worker.dispose(); + if (currentProgram != null) { + currentProgram.removeTransactionListener(transactionListener); + currentProgram.removeListener(this); + } tool.getProject().getProjectData().removeDomainFolderChangeListener(folderListener); From 7179c6de814efcdcb09e7aabd321b7a60913f3a9 Mon Sep 17 00:00:00 2001 From: ghidra1 Date: Tue, 26 Mar 2019 14:55:19 -0400 Subject: [PATCH 22/35] GT-2667 added support for generating sleigh build.xml files --- .gitignore | 1 + Ghidra/Features/FileFormats/data/build.xml | 73 ------ .../java/ghidra/framework/Application.java | 20 +- .../Framework/SoftwareModeling/Sleigh.launch | 40 +-- .../Framework/SoftwareModeling/build.gradle | 4 + .../processors/sleigh/SleighLanguage.java | 36 ++- .../slgh_compile/SleighCompile.java | 12 +- .../slgh_compile/SleighCompileLauncher.java | 229 +++++++++--------- Ghidra/Processors/6502/data/build.xml | 73 ------ Ghidra/Processors/68000/data/build.xml | 73 ------ Ghidra/Processors/6805/data/build.xml | 73 ------ Ghidra/Processors/8051/data/build.xml | 73 ------ Ghidra/Processors/8085/data/build.xml | 76 ------ Ghidra/Processors/AARCH64/data/build.xml | 76 ------ Ghidra/Processors/ARM/data/build.xml | 73 ------ Ghidra/Processors/Atmel/data/build.xml | 73 ------ Ghidra/Processors/CR16/data/build.xml | 73 ------ Ghidra/Processors/DATA/data/build.xml | 73 ------ Ghidra/Processors/JVM/data/build.xml | 73 ------ Ghidra/Processors/MIPS/data/build.xml | 74 ------ Ghidra/Processors/PA-RISC/data/build.xml | 73 ------ Ghidra/Processors/PIC/data/build.xml | 73 ------ Ghidra/Processors/PowerPC/data/build.xml | 73 ------ Ghidra/Processors/Sparc/data/build.xml | 73 ------ Ghidra/Processors/TI_MSP430/data/build.xml | 73 ------ Ghidra/Processors/Toy/data/build.xml | 73 ------ Ghidra/Processors/Z80/data/build.xml | 73 ------ Ghidra/Processors/x86/data/build.xml | 73 ------ GhidraBuild/BuildFiles/certification.manifest | 2 + .../BuildFiles/sleighDevBuild.template | 57 +++++ .../BuildFiles/sleighDistBuild.template | 50 ++++ GhidraBuild/Skeleton/certification.manifest | 1 + GhidraBuild/Skeleton/data/build.xml | 80 ------ GhidraBuild/Skeleton/data/sleighArgs.txt | 6 + gradleScripts/distribution.gradle | 2 + gradleScripts/ip.gradle | 1 + gradleScripts/processorUtils.gradle | 97 +++++--- 37 files changed, 377 insertions(+), 1801 deletions(-) delete mode 100644 Ghidra/Features/FileFormats/data/build.xml delete mode 100644 Ghidra/Processors/6502/data/build.xml delete mode 100644 Ghidra/Processors/68000/data/build.xml delete mode 100644 Ghidra/Processors/6805/data/build.xml delete mode 100644 Ghidra/Processors/8051/data/build.xml delete mode 100644 Ghidra/Processors/8085/data/build.xml delete mode 100644 Ghidra/Processors/AARCH64/data/build.xml delete mode 100644 Ghidra/Processors/ARM/data/build.xml delete mode 100644 Ghidra/Processors/Atmel/data/build.xml delete mode 100644 Ghidra/Processors/CR16/data/build.xml delete mode 100644 Ghidra/Processors/DATA/data/build.xml delete mode 100644 Ghidra/Processors/JVM/data/build.xml delete mode 100644 Ghidra/Processors/MIPS/data/build.xml delete mode 100644 Ghidra/Processors/PA-RISC/data/build.xml delete mode 100644 Ghidra/Processors/PIC/data/build.xml delete mode 100644 Ghidra/Processors/PowerPC/data/build.xml delete mode 100644 Ghidra/Processors/Sparc/data/build.xml delete mode 100644 Ghidra/Processors/TI_MSP430/data/build.xml delete mode 100644 Ghidra/Processors/Toy/data/build.xml delete mode 100644 Ghidra/Processors/Z80/data/build.xml delete mode 100644 Ghidra/Processors/x86/data/build.xml create mode 100644 GhidraBuild/BuildFiles/sleighDevBuild.template create mode 100644 GhidraBuild/BuildFiles/sleighDistBuild.template delete mode 100644 GhidraBuild/Skeleton/data/build.xml create mode 100644 GhidraBuild/Skeleton/data/sleighArgs.txt diff --git a/.gitignore b/.gitignore index 04e661f556..c3fb9d3ddc 100644 --- a/.gitignore +++ b/.gitignore @@ -23,6 +23,7 @@ ghidra.repos.config **/dist repositories/ *.sla +**/data/build.xml # Misc files *.setting diff --git a/Ghidra/Features/FileFormats/data/build.xml b/Ghidra/Features/FileFormats/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Features/FileFormats/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java index e6f02965f7..09572b2b80 100644 --- a/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java +++ b/Ghidra/Framework/Generic/src/main/java/ghidra/framework/Application.java @@ -460,18 +460,19 @@ public class Application { if (module == null) { return null; } - - File file = getModuleFile(module, "build/os/" + Platform.CURRENT_PLATFORM.getDirectoryName(), - exactFilename); + + File file = getModuleFile(module, + "build/os/" + Platform.CURRENT_PLATFORM.getDirectoryName(), exactFilename); if (file == null) { file = getModuleFile(module, "os/" + Platform.CURRENT_PLATFORM.getDirectoryName(), exactFilename); } - + // Allow win32 to be used for win64 as fallback if (file == null && Platform.CURRENT_PLATFORM == Platform.WIN_64) { - file = getModuleFile(module, "build/os/" + Platform.WIN_32.getDirectoryName(), exactFilename); + file = getModuleFile(module, "build/os/" + Platform.WIN_32.getDirectoryName(), + exactFilename); } if (file == null && Platform.CURRENT_PLATFORM == Platform.WIN_64) { file = getModuleFile(module, "os/" + Platform.WIN_32.getDirectoryName(), exactFilename); @@ -492,12 +493,13 @@ public class Application { private File getOSFileInAnyModule(String path) throws FileNotFoundException { - File file = findModuleFile("build/os/" + Platform.CURRENT_PLATFORM.getDirectoryName(), path); - + File file = + findModuleFile("build/os/" + Platform.CURRENT_PLATFORM.getDirectoryName(), path); + if (file == null) { file = findModuleFile("os/" + Platform.CURRENT_PLATFORM.getDirectoryName(), path); } - + // Allow win32 to be used for win64 as fallback if (file == null && Platform.CURRENT_PLATFORM == Platform.WIN_64) { file = findModuleFile("build/os/" + Platform.WIN_32.getDirectoryName(), path); @@ -657,7 +659,7 @@ public class Application { /** * Return the module root directory for the module with the given name. * @param moduleName the name of the module. - * @return the module root directory for the module with the given name. + * @return the module root directory for the module with the given name or null if not found. */ public static ResourceFile getModuleRootDir(String moduleName) { checkAppInitialized(); diff --git a/Ghidra/Framework/SoftwareModeling/Sleigh.launch b/Ghidra/Framework/SoftwareModeling/Sleigh.launch index b4f8e30e41..b8273f84bc 100644 --- a/Ghidra/Framework/SoftwareModeling/Sleigh.launch +++ b/Ghidra/Framework/SoftwareModeling/Sleigh.launch @@ -1,19 +1,27 @@ - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Ghidra/Framework/SoftwareModeling/build.gradle b/Ghidra/Framework/SoftwareModeling/build.gradle index ea5e731db3..afcc62f929 100644 --- a/Ghidra/Framework/SoftwareModeling/build.gradle +++ b/Ghidra/Framework/SoftwareModeling/build.gradle @@ -23,6 +23,10 @@ dependencies { antlr "org.antlr:antlr:3.5.2" } +// Define classpath needed to execute sleigh compiler during development +// (see gradleScripts/processorUtils.gradle) +ext.sleighDevClasspath = project.sourceSets.main.runtimeClasspath.collect { it.absolutePath }.join(':') + def genSrcDir = 'generated-src/antlr/main' generateGrammarSource { diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/SleighLanguage.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/SleighLanguage.java index a0cf138fdb..8c12ac945a 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/SleighLanguage.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/app/plugin/processors/sleigh/SleighLanguage.java @@ -412,11 +412,39 @@ public class SleighLanguage implements Language { String languageName = specName + ".slaspec"; ResourceFile languageFile = new ResourceFile(slaFile.getParentFile(), languageName); + // see gradleScripts/processorUtils.gradle for sleighArgs.txt generation + ResourceFile sleighArgsFile = null; + ResourceFile languageModule = Application.getModuleContainingResourceFile(languageFile); + if (languageModule != null) { + if (SystemUtilities.isInReleaseMode()) { + sleighArgsFile = new ResourceFile(languageModule, "data/sleighArgs.txt"); + } + else { + sleighArgsFile = new ResourceFile(languageModule, "build/data/sleighArgs.txt"); + } + } + + Map defineMap; + String[] args; + if (sleighArgsFile != null && sleighArgsFile.isFile()) { + args = new String[] { "-i", sleighArgsFile.getAbsolutePath(), + languageFile.getAbsolutePath(), description.getSlaFile().getAbsolutePath() }; + defineMap = new HashMap<>(); + } + else { + args = new String[] { languageFile.getAbsolutePath(), + description.getSlaFile().getAbsolutePath() }; + defineMap = ModuleDefinitionsMap.getModuleMap(); + } + try { - int returnCode = SleighCompileLauncher.runMain( - new String[] { languageFile.getAbsolutePath(), - description.getSlaFile().getAbsolutePath() }, - ModuleDefinitionsMap.getModuleMap()); + StringBuilder buf = new StringBuilder(); + for (String str : args) { + buf.append(str); + buf.append(" "); + } + Msg.debug(this, "Sleigh compile: " + buf); + int returnCode = SleighCompileLauncher.runMain(args, defineMap); if (returnCode != 0) { throw new SleighException("Errors compiling " + languageFile.getAbsolutePath() + " -- please check log messages for details"); diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/SleighCompile.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/SleighCompile.java index cd3f56fad9..895c894be6 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/SleighCompile.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/SleighCompile.java @@ -963,10 +963,9 @@ public class SleighCompile extends SleighBase { continue; } if (firstContextField != null && sym.getId() == firstContextField) { - reportError(location, - sym.getName() + - " cannot be used to attach variables because it occurs at the lowest bit position in context at " + - sym.getLocation()); + reportError(location, sym.getName() + + " cannot be used to attach variables because it occurs at the lowest bit position in context at " + + sym.getLocation()); continue; } PatternValue patval = sym.getPatternValue(); @@ -1569,7 +1568,9 @@ public class SleighCompile extends SleighBase { } /** - * Run the sleigh compiler. + * Run the sleigh compiler. This provides a direct means of invoking the + * compiler without using the launcher. The full SoftwareModeling classpath + * must be established including any dependencies. * @param args compiler command line arguments * @throws JDOMException * @throws IOException @@ -1578,5 +1579,4 @@ public class SleighCompile extends SleighBase { public static void main(String[] args) throws JDOMException, IOException, RecognitionException { System.exit(SleighCompileLauncher.runMain(args, new HashMap())); } - } diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/SleighCompileLauncher.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/SleighCompileLauncher.java index 299ffdc938..c678b37ef7 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/SleighCompileLauncher.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcodeCPort/slgh_compile/SleighCompileLauncher.java @@ -21,17 +21,18 @@ import java.util.Map.Entry; import org.antlr.runtime.*; import org.antlr.runtime.tree.CommonTreeNodeStream; -import org.jdom.*; -import org.jdom.input.SAXBuilder; +import org.jdom.JDOMException; +import generic.jar.ResourceFile; import generic.stl.IteratorSTL; import ghidra.GhidraApplicationLayout; import ghidra.GhidraLaunchable; +import ghidra.framework.Application; +import ghidra.framework.ApplicationConfiguration; import ghidra.pcodeCPort.context.SleighError; -import ghidra.pcodeCPort.translate.XmlError; import ghidra.sleigh.grammar.*; import ghidra.util.Msg; -import ghidra.util.xml.XmlUtilities; +import ghidra.util.SystemUtilities; import utilities.util.FileResolutionResult; import utilities.util.FileUtilities; @@ -63,6 +64,11 @@ public class SleighCompileLauncher implements GhidraLaunchable { @Override public void launch(GhidraApplicationLayout layout, String[] args) throws JDOMException, IOException, RecognitionException { + + // Initialize the application + ApplicationConfiguration configuration = new ApplicationConfiguration(); + Application.initializeApplication(layout, configuration); + System.exit(runMain(args, new HashMap())); } @@ -87,17 +93,24 @@ public class SleighCompileLauncher implements GhidraLaunchable { if (args.length < 1) { // @formatter:off - Msg.info(SleighCompile.class, "USAGE: sleigh [-x] [-dNAME=VALUE] inputfile outputfile"); - Msg.info(SleighCompile.class, " -x turns on parser debugging"); - Msg.info(SleighCompile.class, " -u print warnings for unnecessary pcode instructions"); - Msg.info(SleighCompile.class, " -l report pattern conflicts"); - Msg.info(SleighCompile.class, " -n print warnings for all NOP constructors"); - Msg.info(SleighCompile.class, " -t print warnings for dead temporaries"); - Msg.info(SleighCompile.class, " -e enforce use of 'local' keyword for temporaries"); - Msg.info(SleighCompile.class, " -f print warnings for unused token fields"); - Msg.info(SleighCompile.class, " -DNAME=VALUE defines a preprocessor macro NAME with value VALUE"); - Msg.info(SleighCompile.class, " OR sleigh -a directory-root"); - Msg.info(SleighCompile.class, " compiles all .slaspec files to .sla files anywhere under directory-root"); + Msg.info(SleighCompile.class, "Usage: sleigh [options...] [ [] | -a ]"); + Msg.info(SleighCompile.class, " sleigh [options...] []"); + Msg.info(SleighCompile.class, " source slaspec file to be compiled"); + Msg.info(SleighCompile.class, " optional output sla file (infile.sla assumed)"); + Msg.info(SleighCompile.class, " or"); + Msg.info(SleighCompile.class, " sleigh [options...] -a "); + Msg.info(SleighCompile.class, " directory to have all slaspec files compiled"); + Msg.info(SleighCompile.class, " options:"); + Msg.info(SleighCompile.class, " -x turns on parser debugging"); + Msg.info(SleighCompile.class, " -u print warnings for unnecessary pcode instructions"); + Msg.info(SleighCompile.class, " -l report pattern conflicts"); + Msg.info(SleighCompile.class, " -n print warnings for all NOP constructors"); + Msg.info(SleighCompile.class, " -t print warnings for dead temporaries"); + Msg.info(SleighCompile.class, " -e enforce use of 'local' keyword for temporaries"); + Msg.info(SleighCompile.class, " -f print warnings for unused token fields"); + Msg.info(SleighCompile.class, " -DNAME=VALUE defines a preprocessor macro NAME with value VALUE (option may be repeated)"); + Msg.info(SleighCompile.class, " -dMODULE defines a preprocessor macro MODULE with a value of its module path (option may be repeated)"); + Msg.info(SleighCompile.class, " -i inject options from specified file"); // @formatter:on return 2; } @@ -114,6 +127,13 @@ public class SleighCompileLauncher implements GhidraLaunchable { if (args[i].charAt(0) != '-') { break; } + else if (args[i].charAt(1) == 'i') { + // inject options from file specified by next argument + args = injectOptionsFromFile(args, ++i); + if (args == null) { + return 1; + } + } else if (args[i].charAt(1) == 'D') { String preproc = args[i].substring(2); int pos = preproc.indexOf('='); @@ -125,6 +145,18 @@ public class SleighCompileLauncher implements GhidraLaunchable { String value = preproc.substring(pos + 1); preprocs.put(name, value); // Preprocessor macro definitions } + else if (args[i].charAt(1) == 'd') { + String moduleName = args[i].substring(2); + ResourceFile module = Application.getModuleRootDir(moduleName); + if (module == null || !module.isDirectory()) { + Msg.error(SleighCompile.class, + "Failed to resolve module reference: " + args[i]); + return 1; + } + Msg.debug(SleighCompile.class, + "Sleigh resolved module: " + moduleName + "=" + module.getAbsolutePath()); + preprocs.put(moduleName, module.getAbsolutePath()); // Preprocessor macro definitions + } else if (args[i].charAt(1) == 'u') { unnecessaryPcodeWarning = true; } @@ -155,7 +187,16 @@ public class SleighCompileLauncher implements GhidraLaunchable { } } + if (i < args.length - 2) { + Msg.error(SleighCompile.class, "Too many parameters"); + return 1; + } + if (allMode) { + if (i == args.length) { + Msg.error(SleighCompile.class, "Missing input directory path"); + return 1; + } String directory = args[i]; File dir = new File(directory); if (!dir.exists() || !dir.isDirectory()) { @@ -195,6 +236,7 @@ public class SleighCompileLauncher implements GhidraLaunchable { return -totalFailures; } + // single file compile SleighCompile compiler = new SleighCompile(); initCompiler(compiler, preprocs, unnecessaryPcodeWarning, lenientConflict, allNopWarning, deadTempWarning, unusedFieldWarning, enforceLocalKeyWord); @@ -202,60 +244,71 @@ public class SleighCompileLauncher implements GhidraLaunchable { Msg.error(SleighCompile.class, "Missing input file name"); return 1; } - if (i < args.length - 2) { - Msg.error(SleighCompile.class, "Too many parameters"); - return 1; - } filein = args[i]; if (i < args.length - 1) { fileout = args[i + 1]; } - String fileinExamine = filein; - int extInPos = fileinExamine.indexOf(FILE_IN_DEFAULT_EXT); - boolean autoExtInSet = false; - String fileinPreExt = ""; - if (extInPos == -1) {// No Extension Given... - // cout << "No Ext Given" << endl; - fileinPreExt = fileinExamine; - fileinExamine += FILE_IN_DEFAULT_EXT; - filein = fileinExamine; - // cout << "filein = " << filein << endl; - autoExtInSet = true; + String baseName = filein; + if (filein.toLowerCase().endsWith(FILE_IN_DEFAULT_EXT)) { + baseName = filein.substring(0, filein.length() - FILE_IN_DEFAULT_EXT.length()); } - else { - fileinPreExt = fileinExamine.substring(0, extInPos); - } - // cout << "fileinPreExt = " << fileinPreExt << endl; + filein = baseName + FILE_IN_DEFAULT_EXT; - if (fileout != null) { - String fileoutExamine = fileout; - int extOutPos = fileoutExamine.indexOf(FILE_OUT_DEFAULT_EXT); - if (extOutPos == -1) {// No Extension Given... - // cout << "No Ext Given" << endl; - fileoutExamine += FILE_OUT_DEFAULT_EXT; - fileout = fileoutExamine; - // cout << "fileout = " << fileout << endl; - } - retval = run_compilation(filein, fileout, compiler); + String baseOutName = fileout; + if (fileout == null) { + baseOutName = baseName; } - else { - // First determine whether or not to use Run_XML... - if (autoExtInSet) {// Assumed format of at least "sleigh file" . - // "sleigh file.slaspec file.sla" - String fileoutSTR = fileinPreExt; - fileoutSTR += FILE_OUT_DEFAULT_EXT; - fileout = fileoutSTR; - // cout << "generated fileout = " << fileout << endl; - retval = run_compilation(filein, fileout, compiler); - } - else { - retval = run_xml(filein, compiler); - } + else if (fileout.toLowerCase().endsWith(FILE_OUT_DEFAULT_EXT)) { + baseOutName = fileout.substring(0, fileout.length() - FILE_OUT_DEFAULT_EXT.length()); + } + fileout = baseOutName + FILE_OUT_DEFAULT_EXT; + return run_compilation(filein, fileout, compiler); + } + + private static String[] injectOptionsFromFile(String[] args, int index) { + if (index >= args.length) { + Msg.error(SleighCompile.class, "Missing options input file name"); + return null; } - return retval; + + File optionsFile = new File(args[index]); + if (!optionsFile.isFile()) { + Msg.error(SleighCompile.class, + "Options file not found: " + optionsFile.getAbsolutePath()); + if (SystemUtilities.isInDevelopmentMode()) { + Msg.error(SleighCompile.class, + "Eclipse language module must be selected and 'gradle prepdev' prevously run"); + } + return null; + } + ArrayList list = new ArrayList<>(); + for (int i = 0; i <= index; i++) { + list.add(args[i]); + } + + try (BufferedReader r = new BufferedReader(new FileReader(optionsFile))) { + String option = r.readLine(); + while (option != null) { + option = option.trim(); + if (option.length() != 0 && !option.startsWith("#")) { + list.add(option); + } + option = r.readLine(); + } + } + catch (IOException e) { + Msg.error(SleighCompile.class, + "Reading options file failed (" + optionsFile.getName() + "): " + e.getMessage()); + return null; + } + + for (int i = index + 1; i < args.length; i++) { + list.add(args[i]); + } + return list.toArray(new String[list.size()]); } private static int run_compilation(String filein, String fileout, SleighCompile compiler) @@ -384,64 +437,4 @@ public class SleighCompileLauncher implements GhidraLaunchable { return 0; } - private static int run_xml(String filein, SleighCompile compiler) - throws JDOMException, IOException, RecognitionException { - FileInputStream s = new FileInputStream(new File(filein)); - Document doc = null; - String specfileout = ""; - String specfilein = ""; - - try { - SAXBuilder builder = XmlUtilities.createSecureSAXBuilder(false, false); - doc = builder.build(s); - } - catch (XmlError err) { - Msg.error(SleighCompile.class, - "Unable to parse single input file as XML spec: " + filein, err); - return 1; - } - s.close(); - - Element el = doc.getRootElement(); - for (;;) { - List list = el.getChildren(); - Iterator iter = list.iterator(); - while (iter.hasNext()) { - el = (Element) iter.next(); - if (el.getName().equals("processorfile")) { - specfileout = el.getText(); - List atts = el.getAttributes(); - Iterator i = atts.iterator(); - while (i.hasNext()) { - Attribute att = (Attribute) i.next(); - if (att.getName().equals("slaspec")) { - specfilein = att.getValue(); - } - else { - compiler.setPreprocValue(att.getName(), att.getValue()); - } - } - } - else if (el.getName().equals("language_spec")) { - break; - } - else if (el.getName().equals("language_description")) { - break; - } - } - if (!iter.hasNext()) { - break; - } - } - - if (specfilein.length() == 0) { - Msg.error(SleighCompile.class, "Input slaspec file was not specified in " + filein); - return 1; - } - if (specfileout.length() == 0) { - Msg.error(SleighCompile.class, "Output sla file was not specified in " + filein); - return 1; - } - return run_compilation(specfilein, specfileout, compiler); - } } diff --git a/Ghidra/Processors/6502/data/build.xml b/Ghidra/Processors/6502/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/6502/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/68000/data/build.xml b/Ghidra/Processors/68000/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/68000/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/6805/data/build.xml b/Ghidra/Processors/6805/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/6805/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/8051/data/build.xml b/Ghidra/Processors/8051/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/8051/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/8085/data/build.xml b/Ghidra/Processors/8085/data/build.xml deleted file mode 100644 index 2164d961ae..0000000000 --- a/Ghidra/Processors/8085/data/build.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/AARCH64/data/build.xml b/Ghidra/Processors/AARCH64/data/build.xml deleted file mode 100644 index 7c1d69306c..0000000000 --- a/Ghidra/Processors/AARCH64/data/build.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/ARM/data/build.xml b/Ghidra/Processors/ARM/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/ARM/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/Atmel/data/build.xml b/Ghidra/Processors/Atmel/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/Atmel/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/CR16/data/build.xml b/Ghidra/Processors/CR16/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/CR16/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/DATA/data/build.xml b/Ghidra/Processors/DATA/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/DATA/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/JVM/data/build.xml b/Ghidra/Processors/JVM/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/JVM/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/MIPS/data/build.xml b/Ghidra/Processors/MIPS/data/build.xml deleted file mode 100644 index a6301d23ca..0000000000 --- a/Ghidra/Processors/MIPS/data/build.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/PA-RISC/data/build.xml b/Ghidra/Processors/PA-RISC/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/PA-RISC/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/PIC/data/build.xml b/Ghidra/Processors/PIC/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/PIC/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/PowerPC/data/build.xml b/Ghidra/Processors/PowerPC/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/PowerPC/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/Sparc/data/build.xml b/Ghidra/Processors/Sparc/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/Sparc/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/TI_MSP430/data/build.xml b/Ghidra/Processors/TI_MSP430/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/TI_MSP430/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/Toy/data/build.xml b/Ghidra/Processors/Toy/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/Toy/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/Z80/data/build.xml b/Ghidra/Processors/Z80/data/build.xml deleted file mode 100644 index 8f72019712..0000000000 --- a/Ghidra/Processors/Z80/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Ghidra/Processors/x86/data/build.xml b/Ghidra/Processors/x86/data/build.xml deleted file mode 100644 index b80b6d91fa..0000000000 --- a/Ghidra/Processors/x86/data/build.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/GhidraBuild/BuildFiles/certification.manifest b/GhidraBuild/BuildFiles/certification.manifest index 40d82f7a77..95930675a6 100644 --- a/GhidraBuild/BuildFiles/certification.manifest +++ b/GhidraBuild/BuildFiles/certification.manifest @@ -6,3 +6,5 @@ JsonDoclet/.project||GHIDRA||||END| JsonDoclet/Module.manifest||GHIDRA||||END| JsonDoclet/build.gradle||GHIDRA||||END| build.gradle||GHIDRA||||END| +sleighDevBuild.template||GHIDRA||||END| +sleighDistBuild.template||GHIDRA||||END| diff --git a/GhidraBuild/BuildFiles/sleighDevBuild.template b/GhidraBuild/BuildFiles/sleighDevBuild.template new file mode 100644 index 0000000000..d81928bd61 --- /dev/null +++ b/GhidraBuild/BuildFiles/sleighDevBuild.template @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/GhidraBuild/BuildFiles/sleighDistBuild.template b/GhidraBuild/BuildFiles/sleighDistBuild.template new file mode 100644 index 0000000000..ec9976b7c3 --- /dev/null +++ b/GhidraBuild/BuildFiles/sleighDistBuild.template @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/GhidraBuild/Skeleton/certification.manifest b/GhidraBuild/Skeleton/certification.manifest index 25a6ffeb28..89c984df68 100644 --- a/GhidraBuild/Skeleton/certification.manifest +++ b/GhidraBuild/Skeleton/certification.manifest @@ -12,6 +12,7 @@ data/languages/skel.opinion||GHIDRA||||END| data/languages/skel.pspec||GHIDRA||||END| data/languages/skel.sinc||GHIDRA||||END| data/languages/skel.slaspec||GHIDRA||||END| +data/sleighArgs.txt||GHIDRA||||END| extension.properties||GHIDRA||||END| ghidra_scripts/README.txt||GHIDRA||||END| lib/README.txt||GHIDRA||||END| diff --git a/GhidraBuild/Skeleton/data/build.xml b/GhidraBuild/Skeleton/data/build.xml deleted file mode 100644 index b83278c5e4..0000000000 --- a/GhidraBuild/Skeleton/data/build.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/GhidraBuild/Skeleton/data/sleighArgs.txt b/GhidraBuild/Skeleton/data/sleighArgs.txt new file mode 100644 index 0000000000..ce06926358 --- /dev/null +++ b/GhidraBuild/Skeleton/data/sleighArgs.txt @@ -0,0 +1,6 @@ +# Add sleigh compiler options to this file (one per line) which will +# be used when compiling each language within this module. +# All options should start with a '-' character. +# +# IMPORTANT: The -a option should NOT be specified +# \ No newline at end of file diff --git a/gradleScripts/distribution.gradle b/gradleScripts/distribution.gradle index 69df51a986..7aaf03b2f4 100644 --- a/gradleScripts/distribution.gradle +++ b/gradleScripts/distribution.gradle @@ -223,6 +223,7 @@ task assembleCommon (type: Copy) { from (p.projectDir.toString() + "/data") { into { getZipPath(p) + "/data" } + exclude 'build.xml' // associated with language modules (dev use only) } from (BIN_REPO + '/' + getZipPath(p) + "/data") { @@ -697,6 +698,7 @@ subprojects { p -> exclude 'bin/**' exclude 'src/**' exclude 'test/**' + exclude 'data/build.xml' exclude 'developer_scripts' // general place where extension modules can put files that won't get diff --git a/gradleScripts/ip.gradle b/gradleScripts/ip.gradle index 16b0c91b08..18a778c275 100644 --- a/gradleScripts/ip.gradle +++ b/gradleScripts/ip.gradle @@ -120,6 +120,7 @@ def Map> getIpForModule(Project p) { exclude "build.gradle" exclude "**/Misc/Tips.htm" exclude "**/*.sla" + exclude "**/data/build.xml" // language build file (generated for dev only) exclude "**/.gradle/**" exclude "**/.settings/**" exclude "**/.vs/**" diff --git a/gradleScripts/processorUtils.gradle b/gradleScripts/processorUtils.gradle index 99bb843875..7d83c68ccc 100644 --- a/gradleScripts/processorUtils.gradle +++ b/gradleScripts/processorUtils.gradle @@ -1,4 +1,3 @@ - /***************************************************************************************** * * Create a configuration so the a dependency can be declared on the the software modeling @@ -14,6 +13,64 @@ dependencies { sleighConfig project(':SoftwareModeling') } +/***************************************************************************************** + * + * Task to write sleigh compiler args to build/data/sleighArgs.txt for use with sleigh + * external sleigh compiler. + * + *****************************************************************************************/ +task saveSleighArgs { + def sleighArgsFile = file("build/data/sleighArgs.txt") + outputs.files sleighArgsFile + outputs.upToDateWhen { false } + doLast { + sleighArgsFile.withWriter { out-> + project.sleighCompile.args.each { a-> + // don't save -a option + if (!"-a".equals(a)) { + out.println a + } + } + } + } +} + +prepDev.dependsOn(saveSleighArgs) + +/***************************************************************************************** + * + * Task to write sleigh build.xml file for use is development mode only. + * + *****************************************************************************************/ +task writeSleighDevBuild { + def templateFilePath = project(':BuildFiles').projectDir.toString() + "/sleighDevBuild.template" + doLast { + // Generate build.xml with injected classpath for running sleigh compiler + copy { + into "data" + from (templateFilePath) { + rename { "build.xml" } + expand ( [ 'gradleSleighDevClasspath': project(':SoftwareModeling').sleighDevClasspath ] ) + } + } + } +} + +prepDev.dependsOn(writeSleighDevBuild) + +/***************************************************************************************** + * + * Write sleigh build.xml file for each language module into assembleCommon + * + *****************************************************************************************/ +rootProject.assembleCommon { + into (getZipPath(this.project) + "/data") { + from (rootProject.projectDir.toString() + "/GhidraBuild/BuildFiles/sleighDistBuild.template") { + rename { "build.xml" } + } + } +} + /***************************************************************************************** * * Task to compile language files using the sleigh compiler. @@ -22,17 +79,16 @@ dependencies { task sleighCompile (type: JavaExec) { group = rootProject.GHIDRA_GROUP description " Compiles all the sleigh languages. [processorUtils.gradle]\n" - + // define standard parameters for JavaExec classpath configurations.sleighConfig main = 'ghidra.pcodeCPort.slgh_compile.SleighCompile' - args '-a' - // Delay adding the directory argument until the first part of the execution phase, so // that any extra args added by a project override will be added to the arg list before - // this argument. + // these arguments. doFirst { + args '-a' args './data/languages' } @@ -40,8 +96,9 @@ task sleighCompile (type: JavaExec) { } // The task that copies the common files to the distribution folder must depend on -// this sleigh task before executing. +// the sleigh tasks before executing. rootProject.assembleCommon.dependsOn(sleighCompile) +rootProject.assembleCommon.dependsOn(saveSleighArgs) // For all tasks of type:Test (i.e., integrationTest, cunitTest, etc.), add a task dependency to // sleighCompile. The sleighCompile task inputs and outputs are defined such that the *.slaspec @@ -52,8 +109,9 @@ rootProject.assembleCommon.dependsOn(sleighCompile) // modules as seen in the use of ghidra.test.ToyProgramBuilder. // The tasks of type:Test do not know about sleighCompile during their configuration phase, so the // dependency must be done in this gradle file. -rootProject.subprojects.findAll { subproject -> - if (!isSupportModule(subproject)) { +rootProject.subprojects.findAll { subproject -> + boolean isSupporProject = subproject.findProperty("isSupportProject") ?: false; + if (!isSupporProject) { subproject.tasks.withType(Test).all { it.dependsOn(sleighCompile) } @@ -91,26 +149,9 @@ def taskOutputs = fileTree(dir: 'data/languages', include: '**/*.sla') sleighCompile.inputs.files (taskInputs) sleighCompile.outputs.files (taskOutputs) -task eclipseSleighLauncher(type: WriteEclipseLauncher) { - dest = forName("Sleigh $project.name") - isRunFave = true - isDbgFave = false - - classpath = configurations.sleighConfig - main 'ghidra.pcodeCPort.slgh_compile.SleighCompile' - - args '-a' - - // Delay adding the directory argument until the first part of the execution phase, so - // that any extra args added by a project override will be added to the arg list before - // this argument. - doFirst { - args './data/languages' - } - - jvmArgs '-Xmx2048M' -} +// define the sleigh compile inputs to saveSleighArgs to limit task creation to language modules +saveSleighArgs.inputs.files (taskInputs) def isSupportModule(Project p) { return p.findProperty("isSupportProject") ?: false -} \ No newline at end of file +} From 1626d2ee1be756ed459e2f1592f3d25f4034d4d0 Mon Sep 17 00:00:00 2001 From: dragonmacher <48328597+dragonmacher@users.noreply.github.com> Date: Mon, 1 Apr 2019 18:25:05 -0400 Subject: [PATCH 23/35] GT-2716 - Decompiler - Fixed 'Find' highlight ghosts --- .../app/plugin/core/byteviewer/ByteField.java | 8 +++--- .../decompiler/component/ClangTextField.java | 5 ++++ .../decompiler/component/DecompilerPanel.java | 25 +++++++++++++++++- .../actions/FieldBasedSearchLocation.java | 6 ++++- .../core/decompile/actions/FindAction.java | 10 ++++++- .../java/docking/widgets/SearchLocation.java | 7 +++-- .../fieldpanel/field/ClippingTextField.java | 15 +++++------ .../field/ReverseClippingTextField.java | 18 ++++++------- .../fieldpanel/field/SimpleTextField.java | 11 ++++---- .../field/VerticalLayoutTextField.java | 2 +- .../fieldpanel/support/HighlightFactory.java | 26 +++++++++++++++---- 11 files changed, 94 insertions(+), 39 deletions(-) diff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteField.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteField.java index b2e3dbd969..db7371f355 100644 --- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteField.java +++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteField.java @@ -15,8 +15,6 @@ */ package ghidra.app.plugin.core.byteviewer; -import ghidra.util.ColorUtils; - import java.awt.*; import java.math.BigInteger; @@ -28,6 +26,7 @@ import docking.widgets.fieldpanel.internal.FieldBackgroundColorManager; import docking.widgets.fieldpanel.internal.PaintContext; import docking.widgets.fieldpanel.support.HighlightFactory; import docking.widgets.fieldpanel.support.RowColLocation; +import ghidra.util.ColorUtils; /** * Fields for the ByteViewer. This class extends the SimpleTextField to include @@ -52,7 +51,8 @@ public class ByteField extends SimpleTextField { * @param hlFactory the factory used to create highlights */ public ByteField(String text, FontMetrics fontMetrics, int startX, int width, - boolean allowCursorAtEnd, int fieldOffset, BigInteger index, HighlightFactory hlFactory) { + boolean allowCursorAtEnd, int fieldOffset, BigInteger index, + HighlightFactory hlFactory) { super(text, fontMetrics, startX, width, allowCursorAtEnd, hlFactory); this.fieldOffset = fieldOffset; @@ -64,7 +64,7 @@ public class ByteField extends SimpleTextField { public void paint(JComponent c, Graphics g, PaintContext context, FieldBackgroundColorManager colorManager, RowColLocation cursorLoc, int rowHeight) { paintSelection(g, colorManager, 0); - paintHighlights(g, hlFactory.getHighlights(text, -1)); + paintHighlights(g, hlFactory.getHighlights(this, text, -1)); g.setFont(metrics.getFont()); if (foregroundColor == null) { foregroundColor = context.getForeground(); diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/ClangTextField.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/ClangTextField.java index 46020f53ca..4968cf02c6 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/ClangTextField.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/ClangTextField.java @@ -1,5 +1,6 @@ /* ### * IP: GHIDRA + * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -197,4 +198,8 @@ public class ClangTextField extends WrappingVerticalLayoutTextField { return lineNumberFieldElement.getStringWidth(); } + public int getLineNumber() { + String text = lineNumberFieldElement.getText().trim(); + return Integer.parseInt(text); + } } diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java index aed2123de5..d178ad955a 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java @@ -1,5 +1,6 @@ /* ### * IP: GHIDRA + * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -37,6 +38,7 @@ import docking.widgets.indexedscrollpane.IndexedScrollPane; import ghidra.app.decompiler.*; import ghidra.app.decompiler.component.hover.DecompilerHoverService; import ghidra.app.plugin.core.decompile.DecompileClipboardProvider; +import ghidra.app.plugin.core.decompile.actions.FieldBasedSearchLocation; import ghidra.program.model.address.*; import ghidra.program.model.listing.Function; import ghidra.program.model.listing.Program; @@ -175,6 +177,9 @@ public class DecompilerPanel extends JPanel implements FieldMouseListener, Field if (clipboard != null) { clipboard.selectionChanged(null); } + + // don't highlight search results across functions + currentSearchLocation = null; } private void setLocation(DecompileData oldData, DecompileData newData) { @@ -696,9 +701,27 @@ public class DecompilerPanel extends JPanel implements FieldMouseListener, Field } class SearchHighlightFactory implements HighlightFactory { + @Override public Highlight[] getHighlights(String text, int cursorTextOffset) { - if (currentSearchLocation == null || cursorTextOffset == -1) { + // the search highlight needs the Field in order to work correctly + return new Highlight[0]; + } + + @Override + public Highlight[] getHighlights(Field field, String text, int cursorTextOffset) { + if (currentSearchLocation == null) { + return new Highlight[0]; + } + + ClangTextField cField = (ClangTextField) field; + int highlightLine = cField.getLineNumber(); + + FieldLocation searchCursorLocation = + ((FieldBasedSearchLocation) currentSearchLocation).getFieldLocation(); + int searchLineNumber = searchCursorLocation.getIndex().intValue() + 1; + if (highlightLine != searchLineNumber) { + // only highlight the match on the actual line return new Highlight[0]; } diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/FieldBasedSearchLocation.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/FieldBasedSearchLocation.java index 0d1434155c..191c32cc21 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/FieldBasedSearchLocation.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/FieldBasedSearchLocation.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,4 +38,9 @@ public class FieldBasedSearchLocation extends SearchLocation { public CursorPosition getCursorPosition() { return new DecompilerCursorPosition(fieldLocation); } + + @Override + protected String fieldsToString() { + return super.fieldsToString() + ", fieldLocation=" + fieldLocation; + } } diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/FindAction.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/FindAction.java index 78c48a7cf4..70b23623e0 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/FindAction.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/plugin/core/decompile/actions/FindAction.java @@ -1,5 +1,6 @@ /* ### * IP: GHIDRA + * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -77,13 +78,20 @@ public class FindAction extends DockingAction { if (text != null) { dialog.setSearchText(text); } + // show over the root frame, so the user can still see the Decompiler window tool.showDialog(dialog); } protected FindDialog getFindDialog() { if (findDialog == null) { - findDialog = new FindDialog("Decompiler Find Text", new DecompilerSearcher()); + findDialog = new FindDialog("Decompiler Find Text", new DecompilerSearcher()) { + @Override + protected void dialogClosed() { + // clear the search results when the dialog is closed + decompilerPanel.setSearchResults(null); + } + }; findDialog.setHelpLocation(new HelpLocation("DecompilePlugin", "Find")); } return findDialog; diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/SearchLocation.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/SearchLocation.java index 9dd7087fe0..064f241389 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/SearchLocation.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/SearchLocation.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -60,6 +59,10 @@ public class SearchLocation { @Override public String toString() { - return searchText + "[start=" + startIndexInclusive + ", end=" + endIndexInclusive + "]"; + return searchText + "[" + fieldsToString() + "]"; + } + + protected String fieldsToString() { + return startIndexInclusive + ", end=" + endIndexInclusive; } } diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ClippingTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ClippingTextField.java index 506e1f8667..bb25ba0477 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ClippingTextField.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ClippingTextField.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -129,8 +128,8 @@ public class ClippingTextField implements TextField { int x = findX(col) + startX; - return new Rectangle(x, -textElement.getHeightAbove(), 2, textElement.getHeightAbove() + - textElement.getHeightBelow()); + return new Rectangle(x, -textElement.getHeightAbove(), 2, + textElement.getHeightAbove() + textElement.getHeightBelow()); } /** @@ -315,7 +314,7 @@ public class ClippingTextField implements TextField { if (cursorLoc != null) { cursorTextOffset = screenLocationToTextOffset(cursorLoc.row(), cursorLoc.col()); } - paintHighlights(g, hlFactory.getHighlights(getString(), cursorTextOffset)); + paintHighlights(g, hlFactory.getHighlights(this, getString(), cursorTextOffset)); } protected void paintSelection(Graphics g, FieldBackgroundColorManager colorManager, int row, @@ -344,10 +343,10 @@ public class ClippingTextField implements TextField { } protected void paintHighlights(Graphics g, Highlight[] highlights) { - for (int i = 0; i < highlights.length; i++) { - int startCol = Math.max(highlights[i].getStart(), 0); - int endCol = Math.min(highlights[i].getEnd(), getString().length()); - Color c = highlights[i].getColor(); + for (Highlight highlight : highlights) { + int startCol = Math.max(highlight.getStart(), 0); + int endCol = Math.min(highlight.getEnd(), getString().length()); + Color c = highlight.getColor(); if (endCol >= startCol) { int start = findX(startCol); int end = findX(endCol + 1); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ReverseClippingTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ReverseClippingTextField.java index 3ffa173ccb..bffa921952 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ReverseClippingTextField.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/ReverseClippingTextField.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -142,8 +141,8 @@ public class ReverseClippingTextField implements TextField { int x = findX(col) + textStartX; - return new Rectangle(x, -textElement.getHeightAbove(), 2, textElement.getHeightAbove() + - textElement.getHeightBelow()); + return new Rectangle(x, -textElement.getHeightAbove(), 2, + textElement.getHeightAbove() + textElement.getHeightBelow()); } /** @@ -336,8 +335,7 @@ public class ReverseClippingTextField implements TextField { private void paintDots(Graphics g, int x) { int pos = 1; // skip one pixel for (int i = 0; i < 3; i++) { - if (pos < DOT_DOT_DOT_WIDTH - 2) { // don't paint too close to next - // field. + if (pos < DOT_DOT_DOT_WIDTH - 2) { // don't paint too close to next field g.drawRect(x + pos, -2, 1, 1); pos += 4; // add in size of dot and padding } @@ -349,14 +347,14 @@ public class ReverseClippingTextField implements TextField { if (cursorLoc != null) { cursorTextOffset = screenLocationToTextOffset(cursorLoc.row(), cursorLoc.col()); } - paintHighlights(g, hlFactory.getHighlights(getString(), cursorTextOffset)); + paintHighlights(g, hlFactory.getHighlights(this, getString(), cursorTextOffset)); } protected void paintHighlights(Graphics g, Highlight[] highlights) { - for (int i = 0; i < highlights.length; i++) { - int startCol = Math.max(highlights[i].getStart() - startingCharIndex, 0); - int endCol = Math.min(highlights[i].getEnd() - startingCharIndex, getString().length()); - Color c = highlights[i].getColor(); + for (Highlight highlight : highlights) { + int startCol = Math.max(highlight.getStart() - startingCharIndex, 0); + int endCol = Math.min(highlight.getEnd() - startingCharIndex, getString().length()); + Color c = highlight.getColor(); if (endCol >= startCol) { int start = findX(startCol); int end = findX(endCol + 1); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/SimpleTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/SimpleTextField.java index a4dbdbbbaf..f75903abb6 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/SimpleTextField.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/SimpleTextField.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -202,7 +201,7 @@ public class SimpleTextField implements Field { public void paint(JComponent c, Graphics g, PaintContext context, FieldBackgroundColorManager colorManager, RowColLocation cursorLoc, int rowHeight) { paintSelection(g, colorManager, 0); - paintHighlights(g, hlFactory.getHighlights(text, -1)); + paintHighlights(g, hlFactory.getHighlights(this, text, -1)); g.setFont(metrics.getFont()); if (foregroundColor == null) { foregroundColor = context.getForeground(); @@ -226,10 +225,10 @@ public class SimpleTextField implements Field { } protected void paintHighlights(Graphics g, Highlight[] highlights) { - for (int i = 0; i < highlights.length; i++) { - int startCol = Math.max(highlights[i].getStart(), 0); - int endCol = Math.min(highlights[i].getEnd(), text.length()); - Color c = highlights[i].getColor(); + for (Highlight highlight : highlights) { + int startCol = Math.max(highlight.getStart(), 0); + int endCol = Math.min(highlight.getEnd(), text.length()); + Color c = highlight.getColor(); if (endCol >= startCol) { int start = findX(startCol); int end = findX(endCol + 1); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/VerticalLayoutTextField.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/VerticalLayoutTextField.java index 7f4e79319a..dad543cad9 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/VerticalLayoutTextField.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/field/VerticalLayoutTextField.java @@ -268,7 +268,7 @@ public class VerticalLayoutTextField implements TextField { cursorRow = cursorLoc.row(); } - Highlight[] highlights = hlFactory.getHighlights(getText(), cursorTextOffset); + Highlight[] highlights = hlFactory.getHighlights(this, getText(), cursorTextOffset); int columns = 0; int n = subFields.size(); Color fieldBackgroundColor = colorManager.getBackgroundColor(); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HighlightFactory.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HighlightFactory.java index 3d46ca7e66..4a97453560 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HighlightFactory.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HighlightFactory.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,13 +15,30 @@ */ package docking.widgets.fieldpanel.support; +import docking.widgets.fieldpanel.field.Field; + public interface HighlightFactory { + /** - * Returns the highlights for the given text. - * @param text the text to be considered for highlighting. + * Returns the highlights for the given text + * + * @param text the text to be considered for highlighting * @param cursorTextOffset the position in the given text of the cursor. A -1 indicates the - * cursor is not in this field. - * @return an array of highlights to be rendered. + * cursor is not in this field. + * @return an array of highlights to be rendered */ public Highlight[] getHighlights(String text, int cursorTextOffset); + + /** + * Returns the highlights for the given text + * + * @param field the field that is requesting the highlight + * @param text the text to be considered for highlighting + * @param cursorTextOffset the position in the given text of the cursor. A -1 indicates the + * cursor is not in this field. + * @return an array of highlights to be rendered + */ + public default Highlight[] getHighlights(Field field, String text, int cursorTextOffset) { + return getHighlights(text, cursorTextOffset); + } } From a3121e19a442250f40692a2bf12d62b005d2c37b Mon Sep 17 00:00:00 2001 From: adamopolous Date: Tue, 2 Apr 2019 10:40:08 -0400 Subject: [PATCH 24/35] GT-2703: changed label on intel hex option to be intelligible --- .../Base/src/main/help/help/topics/ExporterPlugin/exporter.htm | 2 +- .../main/java/ghidra/app/util/exporter/IntelHexExporter.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm index 7cc81d3288..3c35967519 100644 --- a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm +++ b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/exporter.htm @@ -308,7 +308,7 @@ address space.
    2. Record Size - Specifies the size (in bytes) of each record in the output file. The default 16.
      3. -
    3. Drop Extra Bytes - If checked, this will ensure that only records matching +
    4. Align To Record Size - If checked, this will ensure that only records matching the record size will be output. eg: if you set the record size to 16 but there are 18 bytes selected, you will see only one line of 16 bytes in the output; the remaining 2 bytes will be dropped.
      5. diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java index 5418555a92..47ba38d9ef 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/IntelHexExporter.java @@ -302,7 +302,7 @@ public class IntelHexExporter extends Exporter { setLayout(new BorderLayout()); input = new HintTextField(Integer.toString(recordSize), false, new BoundedIntegerVerifier()); - dropCb = new JCheckBox("Drop Extra Bytes"); + dropCb = new JCheckBox("Align To Record Size"); input.setText(Integer.toString(recordSize)); From 8cf5b0f2c63bb329ce899e6e60962de90efccebd Mon Sep 17 00:00:00 2001 From: emteere <47253321+emteere@users.noreply.github.com> Date: Tue, 2 Apr 2019 10:45:18 -0400 Subject: [PATCH 25/35] GT-2722 updates for CMP.W and LSL instruction decodes --- .../Processors/ARM/data/languages/ARM.ldefs | 34 +++++++++---------- .../data/languages/ARMTHUMBinstructions.sinc | 9 ++--- 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/Ghidra/Processors/ARM/data/languages/ARM.ldefs b/Ghidra/Processors/ARM/data/languages/ARM.ldefs index f98077ed69..08971e3ddf 100644 --- a/Ghidra/Processors/ARM/data/languages/ARM.ldefs +++ b/Ghidra/Processors/ARM/data/languages/ARM.ldefs @@ -5,7 +5,7 @@ endian="little" size="32" variant="v8" - version="1.101" + version="1.102" slafile="ARM8_le.sla" processorspec="ARMt.pspec" manualindexfile="../manuals/ARM.idx" @@ -22,7 +22,7 @@ instructionEndian="little" size="32" variant="v8LEInstruction" - version="1.101" + version="1.102" slafile="ARM8_le.sla" processorspec="ARMt.pspec" manualindexfile="../manuals/ARM.idx" @@ -37,7 +37,7 @@ endian="big" size="32" variant="v8" - version="1.101" + version="1.102" slafile="ARM8_be.sla" processorspec="ARMt.pspec" manualindexfile="../manuals/ARM.idx" @@ -53,7 +53,7 @@ endian="little" size="32" variant="v7" - version="1.101" + version="1.102" slafile="ARM7_le.sla" processorspec="ARMt.pspec" manualindexfile="../manuals/ARM.idx" @@ -71,7 +71,7 @@ instructionEndian="little" size="32" variant="v7LEInstruction" - version="1.101" + version="1.102" slafile="ARM7_le.sla" processorspec="ARMt.pspec" manualindexfile="../manuals/ARM.idx" @@ -86,7 +86,7 @@ endian="big" size="32" variant="v7" - version="1.101" + version="1.102" slafile="ARM7_be.sla" processorspec="ARMt.pspec" manualindexfile="../manuals/ARM.idx" @@ -102,7 +102,7 @@ endian="little" size="32" variant="Cortex" - version="1.101" + version="1.102" slafile="ARM7_le.sla" processorspec="ARMCortex.pspec" manualindexfile="../manuals/ARM.idx" @@ -117,7 +117,7 @@ endian="big" size="32" variant="Cortex" - version="1.101" + version="1.102" slafile="ARM7_be.sla" processorspec="ARMCortex.pspec" manualindexfile="../manuals/ARM.idx" @@ -132,7 +132,7 @@ endian="little" size="32" variant="v6" - version="1.101" + version="1.102" slafile="ARM6_le.sla" processorspec="ARMt.pspec" manualindexfile="../manuals/ARM.idx" @@ -150,7 +150,7 @@ endian="big" size="32" variant="v6" - version="1.101" + version="1.102" slafile="ARM6_be.sla" processorspec="ARMt.pspec" manualindexfile="../manuals/ARM.idx" @@ -168,7 +168,7 @@ endian="little" size="32" variant="v5t" - version="1.101" + version="1.102" slafile="ARM5t_le.sla" processorspec="ARMt_v45.pspec" manualindexfile="../manuals/ARM.idx" @@ -184,7 +184,7 @@ endian="big" size="32" variant="v5t" - version="1.101" + version="1.102" slafile="ARM5t_be.sla" processorspec="ARMt_v45.pspec" manualindexfile="../manuals/ARM.idx" @@ -200,7 +200,7 @@ endian="little" size="32" variant="v5" - version="1.101" + version="1.102" slafile="ARM5_le.sla" processorspec="ARM_v45.pspec" manualindexfile="../manuals/ARM.idx" @@ -232,7 +232,7 @@ endian="little" size="32" variant="v4t" - version="1.101" + version="1.102" slafile="ARM4t_le.sla" processorspec="ARMt_v45.pspec" manualindexfile="../manuals/ARM.idx" @@ -248,7 +248,7 @@ endian="big" size="32" variant="v4t" - version="1.101" + version="1.102" slafile="ARM4t_be.sla" processorspec="ARMt_v45.pspec" manualindexfile="../manuals/ARM.idx" @@ -264,7 +264,7 @@ endian="little" size="32" variant="v4" - version="1.101" + version="1.102" slafile="ARM4_le.sla" processorspec="ARM_v45.pspec" manualindexfile="../manuals/ARM.idx" @@ -280,7 +280,7 @@ endian="big" size="32" variant="v4" - version="1.101" + version="1.102" slafile="ARM4_be.sla" processorspec="ARM_v45.pspec" manualindexfile="../manuals/ARM.idx" diff --git a/Ghidra/Processors/ARM/data/languages/ARMTHUMBinstructions.sinc b/Ghidra/Processors/ARM/data/languages/ARMTHUMBinstructions.sinc index a9c655d332..48a2d6a29f 100644 --- a/Ghidra/Processors/ARM/data/languages/ARMTHUMBinstructions.sinc +++ b/Ghidra/Processors/ARM/data/languages/ARMTHUMBinstructions.sinc @@ -185,6 +185,7 @@ define token instrThumb (16) thc0815=(8,15) thc0915=(9,15) thc1015=(10,15) + thc1112=(11,12) thc1115=(11,15) thc1215=(12,15) thc1315=(13,15) @@ -1614,7 +1615,7 @@ define pcodeop IndexCheck; @if defined(VERSION_6T2) || defined(VERSION_7) -:cmp^ItCond^".w" Rn0003,ThumbExpandImm12 is TMode=1 & ItCond & (op11=0x1e & thc0909=0 & sop0508=13 & Rn0003; thc1515=0 & thc0811=15) & ThumbExpandImm12 +:cmp^ItCond^".w" Rn0003,ThumbExpandImm12 is TMode=1 & ItCond & (op11=0x1e & thc0909=0 & thc0404=1 & sop0508=13 & Rn0003; thc1515=0 & thc0811=15) & ThumbExpandImm12 { build ItCond; th_subflags(Rn0003,ThumbExpandImm12); @@ -2447,9 +2448,9 @@ define pcodeop ExclusiveAccess; build CheckInIT_ZN; } -:mov^ItCond Rd0002,Rn0305 is TMode=1 & ItCond & op6=0x070 & Rn0305 & Rd0002 & CheckInIT_ZN +:mov^ItCond Rd0002,Rn0305 is TMode=1 & ItCond & op6=0x000 & Rn0305 & Rd0002 & CheckInIT_ZN { - build ItCond; + build ItCond; Rd0002 = Rn0305; resflags(Rd0002); build CheckInIT_ZN; @@ -4482,7 +4483,7 @@ thumbEndianNess: "BE" is op0=0xb658 { export 1:1; } :sub^ItCond sp,Immed7_4 is TMode=1 & ItCond & op7=0x161 & sp & Immed7_4 { build ItCond; - sp = sp - Immed7_4; + sp = sp - Immed7_4; } @if defined(VERSION_6T2) || defined(VERSION_7) From b874111ae730f9f78566f222a945399dcd5997eb Mon Sep 17 00:00:00 2001 From: adamopolous Date: Tue, 2 Apr 2019 11:13:27 -0400 Subject: [PATCH 26/35] GT-2703: added new help image for intel hex options dialog --- .../images/Intel_Hex_Options.png | Bin 8778 -> 7427 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/images/Intel_Hex_Options.png b/Ghidra/Features/Base/src/main/help/help/topics/ExporterPlugin/images/Intel_Hex_Options.png index 8d6087886acedf6d1c98098ddf1be9ed6fc490f3..614e2f37d3b9ae85cf56a7b66cac79c00fc84373 100644 GIT binary patch literal 7427 zcmcI}WmJ^i`>ug>DM+`{B{3i&2q*|hNDSTGIrM;}G^jKZf|N6ZbW3;FfV4CW=`eJi z$M-$IbJqWSIO}{k|1YfJSv&4~-*H{n-cjnR3Pkuc_;>EyAyRzvO5@I*y9&VX8r*xp z->y%;gzwy;>sNdwqvd0~mqlQxg>3HWOPG30{%*}E`k+=}LYR@$+IFK)YURmTyq9#! zM&ICDo);H*CI!9;$;n{!VQ>Vc(vXsB2wgzf%WqgH?RRaVEcZK~JfOkeys_rDZqz$+ z^%;Sm2TAV;A+DDk4)h47y?<0kM6D;Lr>AFRWPJSiF*DP^*tnDpw|(k;{UIeqhZWV{ z`&+~20P3-diV6uVnO|)G^J`*uwyG3a7*#7U!u4oF<%Up(RD>Ybi-V7EqXQVn^K3Ra z0r@RA_csa&vl+=&NqUL>0T;abb$jIK=`3*@$HSv^B(J;x>mqJv? zU1YjCPvcV#_2WDX6U)iAt?P#Q;a=tXji_FB{R1E1lj;)r@dR*}zoH<~Gr>jFWE(SinAU)qC5ZgVQDiC@;4}CTkTTsxYCl33u zam0=*(fSRk+h1{)Og>BJy_|?+-kqSh?2QKS8>N^E7CG6xTc|O0lP8KvexLgR>-n_C z$?NVfDpASZ=){BgA_~RSvU2*c*9`m(nx0(ZSG^;t5bw(;w~pKM|L3EuFyW z;3N~Wjsl;~wljlqF1qj_F=M0WE2f6vz^Dr1Fr@i7s>Ynhq-n=fDM;k4T`!w^|l4pHhmvj?DV#n@8E86Lf#l%XOqJKcv_OG`KTRU3qc zHV{k;zo37Rc;*m(D!FlRYtfJSDgJhCo@|Cwi0)e73aat7wc(IiPEKk@`X92XFh$so z5SeqSL-;o)?gy*3eyVXJ-O(;4ubyq&HxHj@DIDDvQ>cEDys{5e98w$DH~6X35dD~s zx8WgYvY8vyENk$qS&!?;_>xN}{Z+P{5x_kNn1dms1>B6s+69G?`U0_7Nnz^0k zuoQIFx){gA5r(2Rq`cVS*q_1Eo1$<3X04&}^~3yi(VkE4TIc8AznH`aeULlZrZmtw zkfOR})DAo;(CVc=pK$T^Wb|BTn4x|I;aLaElsi`6tYV-xKi1}(Aun!z^GVW_K29oA zc&P$|+`IMjbm<*-5pvm}ybk1E{#`oy6Ca7k-Te*ejXHHo1aeQSG)tmQD%ZO6);)Zv zzJS`t)A6lvi~^mcTjPbYWdWt?buPi)73Xb2UJl9rCwO;Vra$_!7uC2MD;Xqr8fnQ` zIUwY*KxlZ;ujFQ2xK9R(8a>=15c4{ftbRAB2Q3O*ns)?(v7W$!+-qu@<61xMHw9S_ zP{k`p;}a0@(ks0?J7rOB$u4Xx@A77Y2jl3f=!*HKvnS=GJnW>en4RL})mWb&d{TtR zY6+5w#MVx=$?><32D|W89|DlvLW6dupWoP zo$YfyH8eEb-Q5ENn^Q=W^p+o2dTAHEY^snu*Ul;Y0KS4KbiorF1vY6k94i`1+Bk>` z&W&G2cEvtBjvbArHfs<`4RzcIWF$I zopGJVnl0aPaZ7MVf1+5%zh=BHL`@{|bFl?zb$ciIy#$Mb%FD|GD4D`m&-o`co8hV> zLGOa)IJL{3K7f(vr8BoZ{=4pwDMSoRSUkjtlx)Rw{UTT zW{-Qg>MP%bf(>esK!-M}v>vMW*gPZile#&xu(7cLrY@GvH~AjHel%xDK`&OiVovuL z26CJO;u&7_d*79PepRb2RjIPqqH-OZl&E)YvHsJ478ZVb7~Mn;x5PWYd!S#7JlYuY zaCJ?S4w4FzP2lub>7q?B>xekso$=TnFCb%k>w_vOI-7_i(Q_g>gKBZIRwr?#(vQcD z;|wnzUFt%A!?Dk6N$h^jlxv`B4Tpde7;ObxJl!4r8k&%h0Kk>AGhdK?d(zLs6{0t? zva&H0yn)xpIybM#%DJ_nxSw)2D9Mc;L`(TVW}sz#R|?PlP%!ypjkQUQ+dVn zcLtL<69?CNC00f9fyLYt4tA_d?@%)L4dVEa&CttG91`=o#d?n-IyE&lMgemyKbu!rZUJx}ehQ$l=vbC5~iAL^PCjT~Vg`er?;Nrinz6w3moK{--Q@=vES z|IaYOZld)ougF*C=H^OD{fEmPR)CW;xnTt^0RfWT0T?4frBVO&{$#3fU22SeT25-} zhvvZ5ZXzKWR*%i$@LyXOKDoUzP4wLjRs$(AVpMabMvVrw&L!WrJ4mFj60@>i1YY?_ zOG|^PlK-I57w7?gw_A&z_&%8q8kzzySS?c|F2TN9yI{uig zySE<`A|qWrJ(KvEGt%02xFL4;Kgla;WIuqoadOy**alGQ!jM4e+s#z4TG#hlpw13E zNGit!IXUsitW$L zWDJBDvkgY*52Xv?bZ~Mz3fuOE6HrDF(M~l$b_NIEY7f=kcV!@Rx0Jfv72=pw3DFzk z@>uJASYJjb4FCELWes9mwk6Mer39aieKDW+K#z5hle?W!WUkmSC9mG#{h0a- ziG!x2Rwf*43iOJ}xmQ~HllXp9G|9*I_I6UkT4(yo3~g+=+7(rjVrGQ}c=s$-a$5&( z0vG(@VW=RFMZf)^R9UN;Z=T&&jYj?(?MiR$63{F^*#X3);9T%sj3i6{z3fWFIEr4v z>*dpRjTESLw>)Bhq4DzaGGCMBSAjC+-!pSQq!YF!WpOly9;1-lI;BjNKx{KbUCi;~ zmW4SuB9nz_lG+HV$*@k0QmY-N+sWQ$Ymd*#B*akiugqXBc79kG#nnD{{e1`ji#P;d zEypI?S6)vP{)L2IJWSHy1on1vlmk*pV``Sr_kbY_ShzbO18Qm=g{%b1UeuXxfJ`OS zMO}OIQZW?c{z@D9!l~Pd*Z9`o1Y*dyAu_>*U=T2WWopVq8CFcjuKEf)W>dsz*0c?e z5e(O5rZwjp)+73n?X!YMeuPH1W2lTMWL#Wal6pwR1I`ZNa31iutvWWhJqE(g&Q2bB zG8)?T$15%I^6adY8kdZLVR$89J}%^qZg9)#qQ80;)HEd{BO2{vx*Rt@KmSW|>EAvQ z@f)vQije!`Z#6P-=!jt4NCg*XdF(!9pJ5>~ZaSmLvk#OTeZX;?+XfG0qLL*FLRzvp z<4(02_HjSzk1WY0>}(B7zf1=CN1BFxDEHCMZpS3Yb?dOMot+VBP+#GV;c zEcroQ+4mzl?i=UyxDZgy`Hy&ErZkwGV>2bG`EtXXor}|qsMi$RpIKJWpS)1w7q>7c zYIuhLUP4@4*LdgwK^RAsNwHH)tK%p9y1{929DD!f08y6GM8Kc-0Q8qR_f$wrNl9^W zaY;%_#*%)VTCDk{d59Gs21n#gdWR(7qcVZW&2Z;6G+q6dPcRMz4Jy zUYQ9j)5>B&zFM4{o12f%dAignC;d*5dh20=@S_m3$Karg?IMS#?HwI)&iNBmX|wQ= zEpVNL*Y5LxGuNRIh)m7Ji1e+bA7;zI<)^l;Zn0J^9PYR?g#aMW=kz`fF^AfVQPgTr zLjK_K&U8$4bTrXR(jxUcU1!{kSb=PXC$d$H8CF!qv|uyHNcIaT6xtI{zq7x;zqa<& zC268Ktzs6~Z?!va)oZzgb`T}uyLM4BTxGWB4uhR9mtk`2;Qe&ecs&$7>=I<{w zKtg3fBck~7w;vzT_;MRsgLWJIPo0&N@NGa0bY-(iDI`^Xw>Q^?rO7gP$ya}9nR;Hj z6(EVw?>j8l#G;0?BpU1L$|UPtm+zTOQk@79P7=W?FZ$SX=m5wbpk0uf+LEuty|}!r zO-+05mNzd}NAIEH1n0J}=AM7d4KDtMQ>mr`v<&U!sP8m+hB~zRd+Y1ff!BWLiL1fj zd=CTjYHFOfPST4$L3-z1lqS1K7$qZ=^q-BmD`?D{Zf`CVB+IRWh}^0f(|hOyn% z1ZgST(OliAmaBDsxevrve}X~YgP`j2(np#G%l!-DDkIW2e@G@%R2pKzNKzrNMM2z6 zupaAdh>a%T>N~aivZ;Hpa^l)fd%)vK3;RnqtD|)sy4F`lfl4de5kU&|Z`IXD+rtS2 zQckuf6c#V$NabKEFLINAjXYBqg?FK*5C*G7p~K{Cd*C9$awvQ(&RQ)?Je(<`mAHJX zeK}poMoYsx39zZMobSUJ!nM8)-)L!U%nb+!7n!y;MT&q01PrDiZuH!CzrbuaHA!mG zx^PiWi9{g_YZ!Gzat7{e5&9+2iD}&UvP235%~sh-Ut`EF_KV-;>(2jIW9+YX@@#y3 ze6X;v%5ul{EQTC~xkp0McpZzl*GZ-ayBi|XmhdSP2yJfxUQj8QuboW54Q#KcM=jpd z9Y;H3W^d0mZ2sosfN0G>n^UI^qB){yoR^xjy6SmV*7e+6U7u|n@wnjHRHx%qJ^D{} zMc_t$(Axr-p%z=s->^6u8q$TJQ@oj(nV(z!)I9G1oG*R%)+sz@(_wQs>-y?yt>xUl z>btyv1?UiiF|4wEIAF06QAt(1UK!_f%*_Tko?iAh7m3-jKlP)jRDoLTMMt=TGksrj zm*<$}I_st)O#!BwcCTC^74Q^?#!;A{!TUf8U_az_K7Uqzm0P&U71Et{{LO{8@NIIDa=QN1#%!8=$ag8RBeTcy_v2KXqdjG&cxnwApD{Ve04aB5J zzGn97WK|vkR?N|Y?9CpBl1TlP0hjd2X6gERP8)X-oq-X-4M4Zb?D==+F0RREy?gD6`w!~2IXZyF3*iyUTbNPz{rUQ> z384K%SlL@u_hatsM_m)%hjd`WDe#oxBH?2<2rQvi493&Pe+27!_`L{5DG;uj^tCWH ztCYSDkMGOO_N_{!{D+mf3tj39XY&Zg`ieBrZ zieF3S8f!{Kswm~_FJMd+>s^=I6+g3?VLN-8s|gcWLO!#kA;TcDz*<*~EHKuqJ=}Jx z|0WUp->i{=<>zZNm~hQT^$@JMvOIKW%wL#rX+Qiw!r6a7Z+8rpRu!WCL8;KOMZ!<{ zd@Cqr$Jj~iE3+*zO;_!NIU0?wsH_wc6dVTh4L_DGZbqp5SGxd*y*rJS;v0r-G0fh# z4L<|?Y`frx(Rz*FbPV2V4BhwE9>mqW{YQ2S3dgx1ta4A;Sy@@x**7;gk8bndJB38# zirJE9bk|N1mr1~MUZtvD(6MbGMVI^+PUltvmK-6>XeUwbWi6x2;2ML z=K8&H?K(0kK2}W4K^Lg7fqhecG5@td(A>hpml;k{t&bS9J=+R>IdL{Md)Le6I2ZZ& za}8`Av%A^wEq3w+)L6iFUv){~hbIHb<>l|1sJWX&H6lMT&&lY|=;il%IkA45!a=^g z6O}nTH0@j?#$&>OArHyOI_6C80{T2AGE%p~vTrb5NC&R_kcLKIUA>jk{y8=YLzB-R zbEylaQDD5+`vtuhzZdXtolrJX@1!dc;@iYKS>4S!6K&paXr~n#C9mamZmov17v_AA z>8=-Fd(~ulA2^exR0d4rxzs{Vk1wAs9kNv`=S;n^Zi8L6q$Lz$w< zGO>&O9TDO18oI{HhG~uCUS1w;5iOb;k<+g!2+0pvT%lRnfpcwbW``BzYgs@2ylGkj z4h{N9BIt4LytXt;`UAxXWZk#dF%+31PAh6}u>Ox*1D@x;Xv@x2J|oof z@>okykXXFHZ8)W|tA~ffM4?Io!wX$fk{GwuZZQc7pcN}J-1gZIluN)G`Ag|)N`f_W zbZ#F6H{$Gru`hYWgH3DGB|f_B%*^fd>Cj0?&f2xpbPVid2peLntQt5_S67RRh)}2~ zzkR!=_Qo_A(B<2}H9XL2&Mz-3nZ9^JAXzW`z1-aeV~>xHEZou#_V#`P!Ud?Nq$F~& z=MdB+prVLqMLhRrwVUtjIWc?LR3C)&15y~rWt78sC$nL2KF)a2#w}X#xvf!phaAa^ zi(TxsIiC}+K*v!zUVSg3c^4mFqt9BtDc|0tPG|I@A|r9DM1_PtOTYUZM=NTcGK_Y0 zU+IkExn2IiXf6{!2yl6~93)Im*g?V-v0A^lH9**icqK9&BIzBzjmBy0YchhCoSaV~Ff_k}32*E-F0!@GBBPQ`rD z-vSVHyVF0G?!4HI>-{Gj&<#631o#^WM6#3QSIXmG=cKT?uf`q9uo_}e<%PNd6Qko9 zpz{hi%oEK)FJU6|4SY(XO^OSjoAIQMGJ5R?OUoUJadCgE*;d=x*&+0+qvPY{0|5fP zff(-Xecwtoeyp=&+E!f5VWqANp2lvhoVBPaoa@i9(|*iY0!62txdAt{Kku>3d>z>h zs`j)$5I3im2t$@W2~FI-Q1#7JRlCu-RDhe8K3L{=q7aC7wCv3P?wP= z4W4-CpFVxc%VXImPLTu8J#ZERWrcnh$I))NKpD@NK{XX_)%3+{{Ohu&JNTq{^=tQ@ z`KfHKC+{ZZ`{$fI3DLbNXMKP$Y83Os>{L~C0&PG=;~IAKZ|#I4O$SnVsmkf;=^6cZ z1$4#jCpm1R>T+^SfWrYuPo3|PHMuEcT6)FB#qrMb@V0uRMlW1*iuX*}xKHF`TQxi8 z<{AOsyA*W$!W(CR8Mb$Cx`ZajN?U5+mxEkUt#I~H;L(@VjUzB?(D!AsC9LW9Y}FYb z|9Qabzb+IP6-|w6V13lDDc?6RAau3V6&(}fGGEvBz=1%|iLxr_YrltL@@A%nc{*#& z7hSok>QrAZxRDfx>=)(qX~)hxrd43y(f0H^}vjSx>lj*2d%? z0}kD(#RfK03AB{w{wF+_ zO-j#3IsW1ly{R`?q4V*{7w>7`lqsv`n(KQ8sssg9FQ-X2U-JHoK(V{Kj)Phj78dmf zkU7480C8+dww%(dr3>zDuDwG;>lXjM-Ys99 z9|fc_;by)*wP9abSvh<5?*rd+_q9mqzROF}mAk2CRdTYj?aLh>06PU-CulO693Q3; h1epmKMvUE($lKX%5o}tY0*{+_6kn^pDwQ=2`5!&OyAS{X literal 8778 zcmcI~Wmr^S+dWE1BaMV0sdSeD5OoAX#K^-(czR*Hg+$CXrq2ah615 zQtGVv6;g0t)W(X8Z|Jg?8KAbJWzD8Iyx%gshCf)bJeE?C*92jWrQbLQ?jF)EXH)*B z^K9&=T@p?0t9~>$H`uC!K6rolFpT9((~mlXlWThDheO=g*C*hx=y`h8mlYIwxYP*c zK)ei*Vt&?c&q-DM47no^Q;_>+X*SW7M~+@C03FRAhq%^Zsl{W9Jw&STeS0A0?bh(Y zTY7?mr>GRnhcr=+y7Anl`i=GON^|A-1rho*^q+!%Rb^{f6DDKo8*k5u_1iOw#K=N>HC703 zLyYx}N0)t&!#WWzc^kbd*=KWD?76q+l@zzjk89d$UD*<1cGzC`So}>%tR?^o^MJ2 zGcU|y#6-BiTay2+nUtd`U8Txu;e@aq1G3Sv^Aj?_p~%g)KQ znmoTq<=d0wC+P4gMdmXB`|B{8@Kx09~x)pTE&xQzE5?vCofotk9jpRrfzZvS4li(y`Jj`S#!#*ER=KQ1`K0iXNPk+5H<8mREif(oi&eWlOt5qf*aTm{^ zuRNwVl>3kY6PN3&lixl6cmj*+*ACt5o33Uy%Wu5LUIBJ8~R{oj|nRLg}>-%tSN z-!-O(?Q5$mL_P`WkbTDz30>a&X{@DeS6+Slj+rY2UY2%RU2Wyc`0hS3-&w@gcA6ST z{CU_AI$U zj_gm(G7m*ji;wC_1{41*#8vdhgEEX-kEgwRoQ_xY75k~Jg$>0L;R-qThhZ*E42;E8OYpgID~qeT1%*t!-YBGq*u5_ z;)h9?uGXoqx|Sw{25U}mbed+ho^Nvw+K{d~a%shVKN`W*MZ!oUbTp7!Hq6z7n~*+O{u&7~j+&;~5115G5;kmlGTrHl2q>8r`Cu_RehvVEU`a zR8p6~50U{r)5jJ5va5mgpHu>i+S)XLYJ`S6sn`)6A{#r0|%eARJSmAtwjH#3-Ex-dVuwvKxzbyo>YubIOBx2(#Ro1K*r zoCGTLR5O~Dj?T;MlpIdQ3ytfNi&gswB9J3dGdhu`jbhfrd_cYjl3z#8jQn#cP!_m| z53E6mqUzXW4!8BCVMec{74LoeUmQ$Oe|ksKV;x{ZFBagWftKo@hNBWJq6E@{#RkU3 z!No|WxuQapcebXVBF;=1HDkc(Q2RO+Zwtt9;+4f}WDU^|;(=tAX=(>Nucq5Bx-!W` z#KjV0pG<1&$X+EsUYQQu;{19i=O*IMtjxolOEv3)ESObGLOs1L2n)~5ovNkwx+5%I zQgie$K_Z%Ry+K>Z-Qnc~S<|(n)qU*Gp2H^P+KuzY{QbrihCjg-6~*R-AK^}@2(|A) z<*V)f9WhW+QD_06tnNt7x{AkP=0o`GAHK3Abl3ckQO0nmg_Nx-cD%iArFNm!$a*PY zeUWD#kz*mlv&j*1JBAOz^G{S)uop`yE3;(%YPVK?sJ|p6WfhjXo;Z+~aR?_qNemU+ zAy9n+9_;ULfIhSc7QQvGs!L1^kF={jm8QPhEw}!Q5*8q1)`~a=RZ;{X~#)bxcek+I)~#_g(vj z6o>K!ZAPFs@bP_(h`OuION3^_74r>HZOjJTc1WBbToFdLy(k^0wp! z9x?$|ssJ-Gfu`(;Scyq}vtad|^czDKlfeSR)|P+(P-h?xwTL_Y@aCwQkp2lbJu7Rm zd@M5t2FB`lrxm*rLCaB^L5_Ft-W}Jx^Sb^Flw1dM)kV6s_IV#tB_t%SxPz6`MVrO_ z(6&vYfBy9H@=E5lGO@Dydb}(SM!OqM;4(GPj~^Akq>f#H4sv)8X%+s?Q^!oLtD1=H zSD(gu=+lA~ABtJ_S83ClvSd>IF48*sU7$`z2E9Ai67{~jKDS?J$dH?znfaxC95+Gi z>gbp#2EG6BO7eOAmpu|4NaRbAAJTO5txz!*!spMIx3`0hvZTYW{+3VCDBIfZdmJ@y z9UQQQuDM{5u#yQm(Z6hQT9sbRJFrpJk$mzOAug`Bbh>gLoJ&9Hr>{eqWohL42> z3+HUH*~8sef>AL6Ng%U1lXTgyj!HWAD`Hc>$qk>sNIh@3GYAh>?{j_o7m=8l=yh}P z#l^)u;Di&1{jJM>+qs{w@71p}3{Xs4DDX{EnaN!~o2lg|5OOnM>F{y&T*V3)%+D(7 z;_|Z0pjjA-X^b8r`j@;UP$Q*|7t4B8?}u_RxLS`!i$z*SMyo`J_~-j}%m34DffT4B2T z=YA!AetsfBzyhlVtE?teT;sa;V~Ve8s!qVw+KGnr4w`Qr=pj-$eG(rvReeGGTU!Ia zLw_@KUV9UzTu-T#5 z9Ad7lPD+QaV0?v8aadc&o8%jJWM>KQlohr-mbAMDfsW43vC#@OlOWpBP0m>TD$6kn zKU&T}1eVUq0jDE~63?%mOXnd?#N)YMwKXw})`JW?+Lxty1>>u{DX94Jm~&fvwABbR zTtHq&I-Zzo*z|s6-2bI*Ts{gjS!3<{0=1)H<|_TdIs6=Ha(v?_$=a1wt2K7>qt^ig zJQqC_{Gu~+a}9NMzZhOwnwi0MKWORkDporzy~O7~X!5#oad#Ic2*RauKVE(k7eH1= z!migVZ;f+m^fV+R;ZE|YgM$OF{U95xem+A9APq8AKY)Y^a2MOtr%zRu=c;YCxv$Un zm^}H5(EvdS=hf{u-*c0| noGa>F2yl(umH?>k?4z1_v3N`JCI9O;DP#|jow#i7{BwZKjGtKt$vf@$sZf z#b4kcu>T8T*Te57051|mGE-m8)H#~Q^cYQ6+e|mQ9#ux`_`QQLWcp0yt0KdfHLI*h zdJZ@ZtINyZOUkfZA`qsIOiWBw-o?yX#gHe^%GN(!Jv~|P++Y03H|`9yB`-b)7tG!`oT+n7_KVER%{3wN(u|P2_LsPVUP(WoX{IF% zF}vl=!pl5Y&wu@;)I{ubTY-e=$o-e7D14nZZyrVporMIb!yZ#0?-{G5AnaFEp3YUj zKd)05f!?1#>XRmMn*-mKUX8%1okM6?tlJt?r!P;<2HNve7@j=5bv5iBqn|A434q?I zcO){OuyZD6@c-TYQqlX}gjj}rSVMP^_0z@J?L%l#*3N?#uY^RY*aAs(_y%om0R_95 z2w54XtOhE5)W=uF$a_kfdlS6jrTe(h;Ri`%AnRMC3 zQd-4KuWQ!(k{=S*DP*EU$e{(ktaV!9EwAMv$KvcJ2+g#KS`NmeuNCL=!*8zbDArKz zv9A#Y4@V>3xSpGc`3X(>ue~?57HF6XcYLI2rtkdmVE1hIo(kC76(+K+@u}{Ya^nX~ zA;7nem&6yyQvA-1A-g}h&y4xCqi8-peH@V?1h5H^LPJLAKYn8^wggycWi?x*RR#$CWWK83 z!`-cGC_9Vw!g-17(PAd`7RQUh(1*Vx(B0n!rWO`?Dz8V+kIntq9%F!6D8HLO+nJDw zpzO0Kz$vG_akLl$e-nOBVyK9@^r}=FhDPo4Nja)ApcQ|uBLHia!0cILd~NOJU&I!u zb%RM@-2_y#gHv8nA>IfTc}V>=8G7VCEnp6UtRA&KM1+MAYUA4n5r6r*6Apg&dHYAH z^H&ulc$bCKvbyDBQ+;wWg>V+5Qj$gySm`=>*z9TJSeuFe+X%Uk@bJl2xS+CvTfQ=%&nH`Sn?G$k_m{IjEDLC?zWZczg{sSM#?46%Y>%4S9KbUPKn5q!LFeS;iii}wMsKDGtM%}57S#9X#TcvJqj-=k=!1JAh6LPnYSMmR=c}DT z@QY-ydlQs0*tb>Ys;vCB*0G9!?VpMZgy28!k1Un1eOOsozWT((rPV@#TJV{)oSa-j zX_-!SD3wV`guu%E-3^cVU_Ow`4};n9lz4Sd$#ewTh&psny2B~98y)dID+!rCtYdwr zdV8@~)*81cYqL}cy&P7fC1uI%@qIGNJL|$VE9@da(U1p7_4MmpDEY-hgleHLrZPxvK2H zy+OH@AjuUfe=dwZLxG6UskW{tT4?%8NNr+d^y^Go=VnUaa8a8a0NWtW=ukpZQbS`S z?AKK4_}P9zH^(uA(4rBH&X#R~C-mmp)yr>WWpYI9A%)7?OQWUyxd?c0Xb5CcWj;ji z5{yCYG{*k-bi)BuWrY2^>Dko>CFoKfG_T+GPzZN%e|M z;tGcov}~}wpi^b}1i91y(-=TQ>#5>C#zn~IHvQu4W9f!#u%ycoE0^B$qcFhVpQiUn2xc?QPFWeqQuQNEWW6fWW?JAZW++)ehI;S;^kFZ{8Wc(F zlbHCzT%I)?^u}rI=Cppp0nX8S8||>v;o8>L!l7HPp7VSsoNQ-jhb)WpBS!1r7#&r& zJGN*bx??4*bVkN}TVp&PQ(2iztBG7d4a^w=1jZ+8$?H5U`hLU{`ve6&6Xu-4uv&Oi zlKN4Z&&b9m>?=B^k=$sJ7Kh%Czfxy?J9Cl|G9#r9`@)~luR)%&naUD-S@L7RR_S1q z3R3OB!$?ho+nz>`uvxIID!pIp?rFyjILh|%qHa}Zc)LDk1}aA4BJ}aF7)pXaJBO(5 zp(W7zD`63`H#N`xS$&$ytr(2f294;T*g4Y0nQexl^bUt^<5zs{?xHdn|A$4#1^wCbCN^0OjSWVuX3Q{$7=6A(1(pl*3?o%8ft|Q!C%FRTR-T5YO>g zu4{AYV3U(DpZ7~{Sb{uJ5@IuY+Iful;7&lG_bti|>SiZYp`+HIVq&g0ZQqe`d!EKZ zk&W^6esVB+V(U{FVHzu8QN0$P1w;v(S~LYdhIA~7pi-(?2S5nEYjlkx(1xgr>9{_! zhMa_H{8zBR;j6qa(*nq2*ZC6uS()s|{$!l7@;R^XrCCfc?)GPS#RmupHN=-^@QQrFyD{)1^Wu!lY5x@nhcsh}*B9R}gE8I`sSN@ilk-H&v{6rftoli=xA{ogLcPP?^!qr?7gX~85=-K>QcHZm zsEPp^^H_NYP-Yi!L3|Q9*~G9qfFJu`H%$J^ehe_ZuNIgdJ=0_iqN?=VA6q5(nF3%0 z{og$x-+ps=+d7kivKaO0z>8XSQ4e*)peTN-OQduslb3bCnF2!9F zRf$dIP1)KAyqXUio5r$kb<_6tms);OT}`)QPNm5MPQ7H!R{c@G^HQHxyc3xMS!x{< zhx?U&|Eu}fyXgnE(h_4S5XhL8$-cK6k2#<)#KvY&gPFxeFHyj)u@aJW_Jd0L&Bd|e z{`1EeIDP&6;3W|6*Rk@k@(d9z82?#f#a-pQTEmzoz=n|}dsAPtS)G1dWH!<_l*(8` zwYIl=Lz+H$k68F%fPZT|KbD+A0t!`zD&Wi%7NC2$U4%Y9mJA@xDx)n@KtRC#{XGoO zdm*Rn`1t9=g~s%EUuoGjTm*%M-QC?ovmBoOXFqHk1xMgovkpHi(;cFCgL1%SM~Bn3 z`;dw35Y6iAZ2Y-~_M?BBJJM%*@Q}dO-={mHv-cQ(sqCPV@bvi3zvM{>;n_ zWM*)7HW6+-4U|6AKqa;@5bx;d==o`;+!$y)^_$(RtE>5-sFfx;m6;pAJ!R58dnTFN zZLG}roT!t`Sw;kn%kK*H;2uYOFUrYxlFZp`1neFRVhg8Capjab3hII^R%yW#1AUPEieyg^S&uaDp4Z`GlvZEDB4rQe5xh8BI$B;f8ZkCE z@Aj3T`+I%O&0=yIvL_`ab-Z=jK2@Sy%NDp0T%4faS8U0pI%$&le!x(SHEKV8-CLzd z+-_d9u&b`}!*4;VC@e<~|d0cK57dU~W}tbBmBjhdR8kr7RCLR?&+_6A_Y+Dw-Y_1jd_ zZjWXlgZ+$+jb+z9UodzB&J%v?R|MnuNV*vGVn1;kGf)y7!+|4Hn8d+q*;2kesfOss zRVYGZPc8(PA;hT=c)L0p1>hp@$c-V=by)FkxX$EW&5xYqVRyBmuG|KzJ#*(Y1&-62 z)wI^v;s25!hH~1glOAd=elXy$0YzAO+|QqcP5yN-m@@zYa$d`F`vqYlBWV4Y865cM zoCd4YC{_5&^DehA8r#Qy2GR`JnCE-bVy=fN|BjEb^U+*j-K?0doYIS(?GhVeWYirT zBDIKZ?$YFR8QdF5xLL; z6~6r-GPo5099vXELht=2wZ8W`kJ=KRC~pRO_>p%(_)sdMqwgBsu&7}=#rr{>kGMcY zI{cqmrOnM58J*hO+cTl+)=j@?^KqF$fR9i-OPX*{vmUZj{>Qp`Qkr!u)4$+GLBqoE z&6Je3wl+{1XJljm2aP}==1tdsVdkS3`T^zZd@q%!#O2Y_NHNhbTC?%xZILLk*wIiF zysOReld=%A|w!lz-e-y_An&4AZehm~9l;BPj@feQs3=_oWQ0#vC zB!R!<6X0!%&}NUz>+5UacY>m#X;a}Ss`hRFdDG(I*{%ufF6lBy1b9aTNe=Wus#L Date: Tue, 2 Apr 2019 11:51:32 -0400 Subject: [PATCH 27/35] GT-2723 Finish configuration for min/max address changes for constant reference propagation. --- .../MultiInstructionMemReference.java | 266 ++++++++++++++---- .../analysis/ConstantPropagationAnalyzer.java | 19 +- .../ConstantPropagationContextEvaluator.java | 10 +- .../program/util/SymbolicPropogator.java | 8 +- .../ghidra/program/util/VarnodeContext.java | 13 +- 5 files changed, 256 insertions(+), 60 deletions(-) diff --git a/Ghidra/Features/Base/ghidra_scripts/MultiInstructionMemReference.java b/Ghidra/Features/Base/ghidra_scripts/MultiInstructionMemReference.java index 8681e16449..70b4f86dfb 100644 --- a/Ghidra/Features/Base/ghidra_scripts/MultiInstructionMemReference.java +++ b/Ghidra/Features/Base/ghidra_scripts/MultiInstructionMemReference.java @@ -39,37 +39,59 @@ //@category Analysis import java.math.BigInteger; +import java.util.Arrays; +import java.util.List; import ghidra.app.script.GhidraScript; -import ghidra.program.model.address.*; +import ghidra.program.model.address.Address; +import ghidra.program.model.address.AddressRange; +import ghidra.program.model.address.AddressRangeImpl; +import ghidra.program.model.address.AddressRangeIterator; +import ghidra.program.model.address.AddressSet; +import ghidra.program.model.address.AddressSetView; +import ghidra.program.model.address.AddressSpace; import ghidra.program.model.block.CodeBlock; import ghidra.program.model.block.PartitionCodeSubModel; -import ghidra.program.model.lang.*; +import ghidra.program.model.lang.OperandType; +import ghidra.program.model.lang.Register; +import ghidra.program.model.lang.RegisterValue; import ghidra.program.model.listing.Function; import ghidra.program.model.listing.Instruction; +import ghidra.program.model.pcode.Varnode; import ghidra.program.model.symbol.RefType; +import ghidra.program.model.symbol.Reference; import ghidra.program.model.symbol.SourceType; -import ghidra.program.util.*; +import ghidra.program.util.ContextEvaluator; +import ghidra.program.util.ContextEvaluatorAdapter; +import ghidra.program.util.OperandFieldLocation; +import ghidra.program.util.SymbolicPropogator; +import ghidra.program.util.VarnodeContext; import ghidra.util.exception.CancelledException; -import ghidra.util.task.TaskMonitor; public class MultiInstructionMemReference extends GhidraScript { Address memReferenceLocation = null; private Address curInstrloc; - + private Object[] inputObjects; + private Object[] resultObjects; + private Register singleRegister; + private boolean registerInOut; + @Override public void run() throws Exception { long numInstructions = currentProgram.getListing().getNumInstructions(); monitor.initialize((int) (numInstructions)); monitor.setMessage("Multi-Instruction Reference Markup"); - int currentOpIndex = 0; + int currentOpIndex = -1; Address start = currentLocation.getAddress(); if ((currentSelection == null || currentSelection.isEmpty()) && currentLocation instanceof OperandFieldLocation) { - currentOpIndex = ((OperandFieldLocation) currentLocation).getOperandIndex(); + OperandFieldLocation operandLocation = (OperandFieldLocation) currentLocation; + currentOpIndex = operandLocation.getOperandIndex(); + int subOpIndex = operandLocation.getSubOperandIndex(); + singleRegister = getRegister(start, currentOpIndex, subOpIndex); } // set up the address set to restrict processing @@ -81,6 +103,34 @@ public class MultiInstructionMemReference extends GhidraScript { findMemRefAtOperand(currentOpIndex, refLocationsSet); } + /** + * Get the register at the location + * + * @param opIndex index into operands for instruction + * @param subOpIndex index into operands for an operand location + * + * @return register if there is one at the location + */ + private Register getRegister(Address addr, int opIndex, int subOpIndex) { + if (addr == null) { + return null; + } + + Instruction instr = currentProgram.getListing().getInstructionContaining(addr); + if (instr == null) { + return null; + } + + List defOpRep = instr.getDefaultOperandRepresentationList(opIndex); + if (subOpIndex >= 0 && subOpIndex < defOpRep.size()) { + Object obj = defOpRep.get(subOpIndex); + if (obj instanceof Register) { + return (Register) obj; + } + } + return instr.getRegister(opIndex); + } + @SuppressWarnings("unused") private boolean isSingleInstructions(AddressSet restrictedSet) { if (restrictedSet.isEmpty()) { @@ -106,53 +156,154 @@ public class MultiInstructionMemReference extends GhidraScript { // use context to fill out addresses on certain instructions ContextEvaluator eval = new ContextEvaluatorAdapter() { + @Override + public boolean evaluateContextBefore(VarnodeContext context, Instruction instr) { + // if the requested reference was on an input op-object, get context before exec + return checkContext(true, opIndex, context, instr); + } + @Override public boolean evaluateContext(VarnodeContext context, Instruction instr) { - // TODO: could look at instructions like LEA, that are an address to create a reference to something. + // if the requested reference was on an output op-object, get context after exec + return checkContext(false, opIndex, context, instr); + } + + + private boolean checkContext(boolean input, final int opIndex, VarnodeContext context, Instruction instr) { if (instr.getMinAddress().equals(curInstrloc)) { - if (checkInstructionMatch(opIndex, context, instr)) { + if (checkInstructionMatch(opIndex, input, context, instr)) { return true; } // if instruction is in delayslot, assume reference is good. if (instr.getDelaySlotDepth() > 0) { instr = instr.getNext(); - return checkInstructionMatch(opIndex, context, instr); + return checkInstructionMatch(opIndex, input, context, instr); } } return false; } + - private boolean checkInstructionMatch(final int opIdx, VarnodeContext context, + @Override + public boolean evaluateReference(VarnodeContext context, Instruction instr, int pcodeop, Address address, + int size, RefType refType) { + + return super.evaluateReference(context, instr, pcodeop, address, size, refType); + } + + + private boolean checkInstructionMatch(final int opIdx, boolean input, VarnodeContext context, Instruction instr) { - int firstIndex = opIdx; - if (instr.getRegister(firstIndex) == null) { - firstIndex = 0; - } - for (int index = firstIndex; index < instr.getNumOperands(); index++) { - Object[] opObjects = instr.getOpObjects(index); - for (int indexOpObj = 0; indexOpObj < opObjects.length; indexOpObj++) { - if (!(opObjects[indexOpObj] instanceof Register)) { - continue; + List list = Arrays.asList(input ? inputObjects : resultObjects); + + for (int index = opIdx; index < instr.getNumOperands(); index++) + { + if (getRefsForOperand(context, instr, list, index)) { + // register is both an in/out check if symbolic on out + if (registerInOut) { + break; } - Register reg = (Register) opObjects[indexOpObj]; - RegisterValue rval = context.getRegisterValue(reg); - if (rval == null) { - continue; - } - BigInteger uval = rval.getUnsignedValue(); - if (uval == null) { - continue; - } - long offset = uval.longValue(); - AddressSpace space = instr.getMinAddress().getAddressSpace(); - Address addr = space.getTruncatedAddress(offset, true); - - // assume that they want the reference, don't worry it isn't in memory - makeReference(instr, index, addr, monitor); - return false; - + return true; } } + if (addSymbolicRefs(input, context, instr, list)) { + return true; + } + return false; + } + + + /** + * Check the current operand for references based on input/outputs + * + * @param context - context holding values + * @param instr - instruction under consideration + * @param list - input/output lists + * @param opIndex - index of operand to check + * + * @return true if a reference was found + */ + private boolean getRefsForOperand(VarnodeContext context, Instruction instr, List list, int opIndex) { + Object[] opObjects = instr.getOpObjects(opIndex); + for (int indexOpObj = 0; indexOpObj < opObjects.length; indexOpObj++) { + if (!(opObjects[indexOpObj] instanceof Register)) { + continue; + } + Register reg = (Register) opObjects[indexOpObj]; + + // if operand has a single register and this isn't it + if (singleRegister != null && !reg.equals(singleRegister)) { + continue; + } + + // check that the register is on the correct input/output list + if (!list.contains(reg)) { + continue; + } + RegisterValue rval = context.getRegisterValue(reg); + if (rval == null) { + continue; + } + BigInteger uval = rval.getUnsignedValue(); + if (uval == null) { + continue; + } + long offset = uval.longValue(); + + AddressSpace space = instr.getMinAddress().getAddressSpace(); + Address addr = space.getTruncatedAddress(offset, true); + + // assume that they want the reference, don't worry it isn't in memory + makeReference(instr, opIndex, addr); + return true; + } + return false; + } + + private boolean addSymbolicRefs(boolean input, VarnodeContext context, Instruction instr, List list) { + // get the value of the single register to see if this is the value desired + if (singleRegister == null) { + return false; + } + // check that the register is on the correct input/output list + if (!list.contains(singleRegister)) { + return false; + } + Varnode registerVarnodeValue = context.getRegisterVarnodeValue(singleRegister); + if (!context.isSymbol(registerVarnodeValue) && !registerVarnodeValue.isRegister()) { + return false; + } + Address symAddr = registerVarnodeValue.getAddress(); + if (symAddr == context.BAD_ADDRESS) { + return false; + } + + String valStr = ""; + if (registerVarnodeValue.isRegister()) { + valStr = context.getRegister(registerVarnodeValue).toString(); + } else { + // is an offset from a space + String name = symAddr.getAddressSpace().getName(); + BigInteger offset = symAddr.getOffsetAsBigInteger(); + valStr = name + " + 0x" + offset.toString(16); + } + Address lastSetLocation = context.getLastSetLocation(singleRegister, null); + + + String comment = instr.getComment(Instruction.EOL_COMMENT); + if (comment == null) { + comment = ""; + } + + String inoutChar = (input ? " " : "\'"); + String lastStr = (lastSetLocation != null ? " @" + lastSetLocation : ""); + + String markup = singleRegister+inoutChar+"= "+ valStr + lastStr; + if (comment.replace('\'',' ').contains(markup.replace('\'',' '))) { + return false; + } + comment = (comment.trim().length()==0 ? markup : comment + "\n" + markup); + instr.setComment(Instruction.EOL_COMMENT, comment); return false; } @@ -188,8 +339,14 @@ public class MultiInstructionMemReference extends GhidraScript { } } - // if the instruction attempting to markup is in the delayslot, backup an instruction Instruction instr = currentProgram.getListing().getInstructionAt(curInstrloc); + if (instr != null) { + inputObjects = instr.getInputObjects(); + resultObjects = instr.getResultObjects(); + registerInOut = checkRegisterInOut(singleRegister, inputObjects, resultObjects); + } + + // if the instruction attempting to markup is in the delayslot, backup an instruction if (instr != null && instr.isInDelaySlot()) { instr = instr.getPrevious(); if (instr != null) { @@ -209,16 +366,24 @@ public class MultiInstructionMemReference extends GhidraScript { } } - /** - * @param instruction - * @param space - * @param scalar - * @param nextInstr - * @param addend - * @param taskMonitor + private boolean checkRegisterInOut(Register reg, Object[] in, Object[] out) { + if (reg == null || in == null || out == null) { + return false; + } + + List inList = Arrays.asList(in); + List outList = Arrays.asList(out); + + return inList.contains(reg) && outList.contains(reg); + } + + /** Make the reference on the instruction at the correct location. + * + * @param instruction to receive reference + * @param space reference created in this space + * @param scalar used as offset into address space */ - private void makeReference(Instruction instruction, int opIndex, Address addr, - TaskMonitor taskMonitor) { + private void makeReference(Instruction instruction, int opIndex, Address addr) { if (instruction.getPrototype().hasDelaySlots()) { instruction = instruction.getNext(); if (instruction == null) { @@ -238,6 +403,13 @@ public class MultiInstructionMemReference extends GhidraScript { if (opIndex == -1) { opIndex = instruction.getNumOperands() - 1; } + + // check if it already has the reference + Reference[] referencesFrom = instruction.getReferencesFrom(); + boolean hasRef = Arrays.stream(referencesFrom).anyMatch(p -> p.getToAddress().equals(addr)); + if (hasRef) { + return; + } if (opIndex == -1) { instruction.addMnemonicReference(addr, RefType.DATA, SourceType.ANALYSIS); diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/ConstantPropagationAnalyzer.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/ConstantPropagationAnalyzer.java index 88206fca8d..b8368f46ad 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/ConstantPropagationAnalyzer.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/ConstantPropagationAnalyzer.java @@ -67,10 +67,16 @@ public class ConstantPropagationAnalyzer extends AbstractAnalyzer { protected static final int MINKNOWNREFADDRESS_OPTION_DEFAULT_VALUE = 4; protected static final String MINSPECULATIVEREFADDRESS_OPTION_NAME = - "Min speculative reference"; + "Speculative reference min"; protected static final String MINSPECULATIVEREFADDRESS_OPTION_DESCRIPTION = "Minimum speculative reference address for offsets and parameters"; protected static final int MINSPECULATIVEREFADDRESS_OPTION_DEFAULT_VALUE = 1024; + + protected static final String MAXSPECULATIVEREFADDRESS_OPTION_NAME = + "Speculative reference max"; + protected static final String MAXSPECULATIVEREFADDRESS_OPTION_DESCRIPTION = + "Maxmimum speculative reference address offset from the end of memory for offsets and parameters"; + protected static final int MAXSPECULATIVEREFADDRESS_OPTION_DEFAULT_VALUE = 256; protected final static int NOTIFICATION_INTERVAL = 100; @@ -80,6 +86,7 @@ public class ConstantPropagationAnalyzer extends AbstractAnalyzer { protected int maxThreadCount = MAXTHREADCOUNT_OPTION_DEFAULT_VALUE; protected long minStoreLoadRefAddress = MINKNOWNREFADDRESS_OPTION_DEFAULT_VALUE; protected long minSpeculativeRefAddress = MINSPECULATIVEREFADDRESS_OPTION_DEFAULT_VALUE; + protected long maxSpeculativeRefAddress = MAXSPECULATIVEREFADDRESS_OPTION_DEFAULT_VALUE; protected boolean followConditional = false; @@ -391,7 +398,7 @@ public class ConstantPropagationAnalyzer extends AbstractAnalyzer { throws CancelledException { ContextEvaluator eval = new ConstantPropagationContextEvaluator(trustWriteMemOption, - minStoreLoadRefAddress, minSpeculativeRefAddress); + minStoreLoadRefAddress, minSpeculativeRefAddress, maxSpeculativeRefAddress); return symEval.flowConstants(flowStart, flowSet, eval, true, monitor); } @@ -461,9 +468,13 @@ public class ConstantPropagationAnalyzer extends AbstractAnalyzer { MINKNOWNREFADDRESS_OPTION_DESCRIPTION); long size = program.getAddressFactory().getDefaultAddressSpace().getSize(); - minSpeculativeRefAddress = size * 8; + minSpeculativeRefAddress = size * 16; options.registerOption(MINSPECULATIVEREFADDRESS_OPTION_NAME, minSpeculativeRefAddress, null, MINSPECULATIVEREFADDRESS_OPTION_DESCRIPTION); + + maxSpeculativeRefAddress = size * 8; + options.registerOption(MAXSPECULATIVEREFADDRESS_OPTION_NAME, maxSpeculativeRefAddress, null, + MAXSPECULATIVEREFADDRESS_OPTION_DESCRIPTION); } @Override @@ -479,6 +490,8 @@ public class ConstantPropagationAnalyzer extends AbstractAnalyzer { options.getLong(MINKNOWNREFADDRESS_OPTION_NAME, minStoreLoadRefAddress); minSpeculativeRefAddress = options.getLong(MINSPECULATIVEREFADDRESS_OPTION_NAME, minSpeculativeRefAddress); + maxSpeculativeRefAddress = + options.getLong(MAXSPECULATIVEREFADDRESS_OPTION_NAME, maxSpeculativeRefAddress); } } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/ConstantPropagationContextEvaluator.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/ConstantPropagationContextEvaluator.java index 08e4ac1315..acb8c08048 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/ConstantPropagationContextEvaluator.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/ConstantPropagationContextEvaluator.java @@ -42,7 +42,9 @@ public class ConstantPropagationContextEvaluator extends ContextEvaluatorAdapter protected AddressSet destSet = new AddressSet(); private boolean trustMemoryWrite = false; private long minStoreLoadOffset = 4; - private long minSpeculativeOffset = 1024; + private long minSpeculativeOffset = 1024; // from the beginning of memory + private long maxSpeculativeOffset = 256; // from the end of memory + public ConstantPropagationContextEvaluator() { } @@ -55,10 +57,10 @@ public class ConstantPropagationContextEvaluator extends ContextEvaluatorAdapter } public ConstantPropagationContextEvaluator(boolean trustWriteMemOption, - long minStoreLoadRefAddress, long minSpeculativeRefAddress) { + long minStoreLoadRefAddress, long minSpeculativeRefAddress, long maxSpeculativeRefAddress) { this(trustWriteMemOption); this.minStoreLoadOffset = minStoreLoadRefAddress; - this.minSpeculativeOffset = minSpeculativeRefAddress; + this.maxSpeculativeOffset = maxSpeculativeRefAddress; } /** @@ -85,7 +87,7 @@ public class ConstantPropagationContextEvaluator extends ContextEvaluatorAdapter long wordOffset = constant.getOffset(); if (((wordOffset >= 0 && wordOffset < minSpeculativeOffset) || - (Math.abs(maxAddrOffset - wordOffset) < minSpeculativeOffset)) && + (Math.abs(maxAddrOffset - wordOffset) < maxSpeculativeOffset)) && !space.isExternalSpace()) { return null; } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/SymbolicPropogator.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/SymbolicPropogator.java index 5486eb65ac..11b468a459 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/SymbolicPropogator.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/SymbolicPropogator.java @@ -43,7 +43,7 @@ public class SymbolicPropogator { // 1. How are "register-relative" varnodes distinguished based upon target space ? Not sure how we handle wrapping/truncation concerns. // 1) The offset is the only thing that could be used as a reference. - private static final int _POINTER_MIN_BOUNDS = 0x7fff; + private static final int _POINTER_MIN_BOUNDS = 0x100; // mask for sub-piece extraction private static long[] maskSize = { 0xffL, 0xffL, 0xffffL, 0xffffffL, 0xffffffffL, 0xffffffffffL, @@ -1836,7 +1836,7 @@ public class SymbolicPropogator { // see if the offset is a large constant offset from the symbolic space long offset = refLocation.getOffset(); - if (checkPossibleOffsetAddr(offset)) { + if (evaluator != null) { // symbolic spaces will have the name of the symbolic space be the register space // String spaceName = refLocation.getAddress().getAddressSpace().getName(); // Register register = vContext.getRegister(spaceName); @@ -1850,7 +1850,7 @@ public class SymbolicPropogator { // } // } else - if (evaluator == null) { + if (!vContext.isStackSymbolicSpace(refLocation) && evaluator != null) { Address constant = program.getAddressFactory().getAddress( (int) targetSpaceID.getOffset(), offset); Address newTarget = evaluator.evaluateConstant(vContext, instruction, @@ -2051,7 +2051,7 @@ public class SymbolicPropogator { */ private int getReferenceSpaceID(Instruction instruction, long offset) { // TODO: this should be passed to the client callback to make the decision - if (offset <= 4096 && offset >= -1) { + if (offset <= 4 && offset >= -1) { return -1; // don't make speculative reference to certain offset values } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/program/util/VarnodeContext.java b/Ghidra/Features/Base/src/main/java/ghidra/program/util/VarnodeContext.java index 6266f9d77c..8be976f8d9 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/program/util/VarnodeContext.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/program/util/VarnodeContext.java @@ -312,7 +312,7 @@ public class VarnodeContext implements ProcessorContext { /** * Return true if this varnode is stored in the symbolic stack space */ - private boolean isStackSymbolicSpace(Varnode varnode) { + public boolean isStackSymbolicSpace(Varnode varnode) { // symbolic spaces are off of a register, find the space AddressSpace regSpace = addrFactory.getAddressSpace(varnode.getSpace()); @@ -785,7 +785,9 @@ public class VarnodeContext implements ProcessorContext { * return the location that this register was last set * This is a transient thing, so it should only be used as a particular flow is being processed... * - * @param reg + * @param reg register to find last set location + * @param bval value to look for to differentiate set locations, null if don't care + * * @return address that the register was set. */ public Address getLastSetLocation(Register reg, BigInteger bval) { @@ -1256,6 +1258,13 @@ public class VarnodeContext implements ProcessorContext { // too big anyway,already extended as far as it will go. vnodeVal = createConstantVarnode(vnodeVal.getOffset(), out.getSize()); } + } else if (vnodeVal.isRegister() && vnodeVal.getSize() < out.getSize()) { + Register reg = getRegister(vnodeVal); + if (reg == null) { + throw notFoundExc; + } + int spaceID = getAddressSpace(reg.getName()); + vnodeVal = createVarnode(0,spaceID,out.getSize()); } return vnodeVal; } From c595e60c65487ff579ae3e0f68addd800562ab0f Mon Sep 17 00:00:00 2001 From: caheckman Date: Tue, 2 Apr 2019 12:56:35 -0400 Subject: [PATCH 28/35] Fix for "Free Varnodes" exceptions in RuleConditionalMove --- Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc b/Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc index af1165c37b..e4326eaffd 100644 --- a/Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc +++ b/Ghidra/Features/Decompiler/src/decompile/cpp/ruleaction.cc @@ -7333,8 +7333,12 @@ bool RuleConditionalMove::BoolExpress::evaluatePropagation(FlowBlock *root,FlowB if (root == branch) return true; // Can always propagate if there is no branch if (op->getParent() != branch) return true; // Can propagate if value formed before branch mustreconstruct = true; // Final op is performed in branch, so it must be reconstructed + if (in0->isFree() && !in0->isConstant()) return false; if (in0->isWritten() && (in0->getDef()->getParent()==branch)) return false; - if ((optype==2) && in1->isWritten() && (in1->getDef()->getParent()==branch)) return false; + if (optype == 2) { + if (in1->isFree() && !in1->isConstant()) return false; + if (in1->isWritten() && (in1->getDef()->getParent()==branch)) return false; + } return true; } From 41f4e2cdde48f4f283f7b5a744eccbe3a48697e7 Mon Sep 17 00:00:00 2001 From: dragonmacher <48328597+dragonmacher@users.noreply.github.com> Date: Tue, 2 Apr 2019 13:05:40 -0400 Subject: [PATCH 29/35] GT-2716 - review fixes --- .../viewer/field/FieldHighlightFactory.java | 18 +++++-------- .../app/util/viewer/options/OptionsGui.java | 3 ++- .../plugin/core/byteviewer/FieldFactory.java | 2 +- .../core/byteviewer/IndexFieldFactory.java | 6 ++--- .../decompiler/component/DecompilerPanel.java | 7 ----- .../internal/TestBigLayoutModel.java | 27 +++++-------------- .../fieldpanel/support/HighlightFactory.java | 14 +--------- .../fieldpanel/FlowLayoutTextFieldTest.java | 9 +++---- .../VerticalLayoutTextFieldTest.java | 9 +++---- 9 files changed, 26 insertions(+), 69 deletions(-) diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldHighlightFactory.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldHighlightFactory.java index c46721d71e..7f340dc38f 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldHighlightFactory.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/FieldHighlightFactory.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,6 +15,7 @@ */ package ghidra.app.util.viewer.field; +import docking.widgets.fieldpanel.field.Field; import docking.widgets.fieldpanel.support.Highlight; import docking.widgets.fieldpanel.support.HighlightFactory; import ghidra.app.util.HighlightProvider; @@ -30,26 +30,22 @@ public class FieldHighlightFactory implements HighlightFactory { private HighlightProvider provider; private Class fieldFactoryClass; private Object obj; - + /** * Constructs a new FieldHighlightFactory. * @param provider the HighlightProvider that will actually compute the highlights. * @param fieldFactoryClass the class of the field factory that generated the field to be rendered. * @param obj the object that holds the information that will be rendered (usually a code unit) */ - public FieldHighlightFactory(HighlightProvider provider, Class fieldFactoryClass, Object obj) { + public FieldHighlightFactory(HighlightProvider provider, + Class fieldFactoryClass, Object obj) { this.provider = provider; this.fieldFactoryClass = fieldFactoryClass; this.obj = obj; } - - /** - * Returns the highlights for the given text. - * @param text the text to be considered for highlighting. - * @return an array of highlights to be rendered. - */ - public Highlight[] getHighlights(String text, int cursorTextOffset) { + + @Override + public Highlight[] getHighlights(Field field, String text, int cursorTextOffset) { return provider.getHighlights(text, obj, fieldFactoryClass, cursorTextOffset); } - } diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/options/OptionsGui.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/options/OptionsGui.java index 0ef35c6d47..4d58561dec 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/options/OptionsGui.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/options/OptionsGui.java @@ -51,7 +51,8 @@ public class OptionsGui extends JPanel { private static final Color DARK_ORANGE = new Color(255, 128, 0); private static final Color DARK_RED = new Color(130, 0, 75); private static final Highlight[] NO_HIGHLIGHTS = new Highlight[0]; - private static final HighlightFactory hlFactory = (text, cursorTextOffset) -> NO_HIGHLIGHTS; + private static final HighlightFactory hlFactory = + (field, text, cursorTextOffset) -> NO_HIGHLIGHTS; public static final ScreenElement COMMENT_AUTO = new ScreenElement("Comment, Automatic", Color.LIGHT_GRAY); diff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/FieldFactory.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/FieldFactory.java index b821e8b3c9..81ed547bfb 100644 --- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/FieldFactory.java +++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/FieldFactory.java @@ -213,7 +213,7 @@ class FieldFactory { } @Override - public Highlight[] getHighlights(String text, int cursorTextOffset) { + public Highlight[] getHighlights(Field field, String text, int cursorTextOffset) { return provider.getHighlights(text, null, null, -1); } } diff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/IndexFieldFactory.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/IndexFieldFactory.java index bd828d425e..cb7ae28d6c 100644 --- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/IndexFieldFactory.java +++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/IndexFieldFactory.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,8 +15,6 @@ */ package ghidra.app.plugin.core.byteviewer; -import ghidra.app.plugin.core.format.ByteBlockInfo; - import java.awt.Color; import java.awt.FontMetrics; import java.math.BigInteger; @@ -26,6 +23,7 @@ import docking.widgets.fieldpanel.field.Field; import docking.widgets.fieldpanel.field.SimpleTextField; import docking.widgets.fieldpanel.support.Highlight; import docking.widgets.fieldpanel.support.HighlightFactory; +import ghidra.app.plugin.core.format.ByteBlockInfo; /** * Implementation for the index/address field. @@ -145,7 +143,7 @@ class IndexFieldFactory { } @Override - public Highlight[] getHighlights(String text, int cursorTextOffset) { + public Highlight[] getHighlights(Field field, String text, int cursorTextOffset) { return NO_HIGHLIGHTS; } } diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java index d178ad955a..9ab2bc8802 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerPanel.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -702,12 +701,6 @@ public class DecompilerPanel extends JPanel implements FieldMouseListener, Field class SearchHighlightFactory implements HighlightFactory { - @Override - public Highlight[] getHighlights(String text, int cursorTextOffset) { - // the search highlight needs the Field in order to work correctly - return new Highlight[0]; - } - @Override public Highlight[] getHighlights(Field field, String text, int cursorTextOffset) { if (currentSearchLocation == null) { diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/TestBigLayoutModel.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/TestBigLayoutModel.java index 371314727f..c2803615ea 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/TestBigLayoutModel.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/internal/TestBigLayoutModel.java @@ -1,6 +1,5 @@ /* ### * IP: GHIDRA - * REVIEWED: YES * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,8 +16,6 @@ package docking.widgets.fieldpanel.internal; import java.awt.*; -import java.awt.event.ActionEvent; -import java.awt.event.ActionListener; import java.math.BigInteger; import java.util.ArrayList; @@ -33,11 +30,8 @@ import docking.widgets.indexedscrollpane.IndexedScrollPane; public class TestBigLayoutModel implements LayoutModel { private static final Highlight[] NO_HIGHLIGHTS = new Highlight[0]; - private static final HighlightFactory hlFactory = new HighlightFactory() { - public Highlight[] getHighlights(String text, int cursorTextOffset) { - return NO_HIGHLIGHTS; - } - }; + private static final HighlightFactory hlFactory = + (field, text, cursorTextOffset) -> NO_HIGHLIGHTS; ArrayList listeners = new ArrayList(); FontMetrics fm; @@ -86,15 +80,13 @@ public class TestBigLayoutModel implements LayoutModel { if (index.compareTo(numIndexes) >= 0) { return null; } - String text = - name + ": This is line " + index + - " More text to make line longer abcdefghijklmnopqrstuvwxyzabcdefghijk"; + String text = name + ": This is line " + index + + " More text to make line longer abcdefghijklmnopqrstuvwxyzabcdefghijk"; FieldElement fe1 = new TextFieldElement(new AttributedString(text, Color.BLACK, fm), 0, 0); FieldElement fe2 = new TextFieldElement(new AttributedString("More text", Color.BLACK, fm), 0, 0); - SingleRowLayout layout = - new SingleRowLayout(new ClippingTextField(20, 300, fe1, hlFactory), - new ClippingTextField(330, 100, fe2, hlFactory)); + SingleRowLayout layout = new SingleRowLayout(new ClippingTextField(20, 300, fe1, hlFactory), + new ClippingTextField(330, 100, fe2, hlFactory)); if (index.intValue() >= startBigSizes && index.intValue() <= endBigSizes) { layout.insertSpaceAbove(30); @@ -143,12 +135,7 @@ public class TestBigLayoutModel implements LayoutModel { contentPane.setLayout(new BorderLayout()); contentPane.add(scrollPanel); JButton button = new JButton("Hit Me"); - button.addActionListener(new ActionListener() { - @Override - public void actionPerformed(ActionEvent e) { - model.updateData(1000, 2000); - } - }); + button.addActionListener(e -> model.updateData(1000, 2000)); contentPane.add(button, BorderLayout.SOUTH); frame.pack(); frame.setVisible(true); diff --git a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HighlightFactory.java b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HighlightFactory.java index 4a97453560..8ac6c85d17 100644 --- a/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HighlightFactory.java +++ b/Ghidra/Framework/Docking/src/main/java/docking/widgets/fieldpanel/support/HighlightFactory.java @@ -19,16 +19,6 @@ import docking.widgets.fieldpanel.field.Field; public interface HighlightFactory { - /** - * Returns the highlights for the given text - * - * @param text the text to be considered for highlighting - * @param cursorTextOffset the position in the given text of the cursor. A -1 indicates the - * cursor is not in this field. - * @return an array of highlights to be rendered - */ - public Highlight[] getHighlights(String text, int cursorTextOffset); - /** * Returns the highlights for the given text * @@ -38,7 +28,5 @@ public interface HighlightFactory { * cursor is not in this field. * @return an array of highlights to be rendered */ - public default Highlight[] getHighlights(Field field, String text, int cursorTextOffset) { - return getHighlights(text, cursorTextOffset); - } + public Highlight[] getHighlights(Field field, String text, int cursorTextOffset); } diff --git a/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/FlowLayoutTextFieldTest.java b/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/FlowLayoutTextFieldTest.java index 675ec2b03f..604bd46201 100644 --- a/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/FlowLayoutTextFieldTest.java +++ b/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/FlowLayoutTextFieldTest.java @@ -15,7 +15,7 @@ */ package docking.widgets.fieldpanel; -import static org.junit.Assert.assertEquals; +import static org.junit.Assert.*; import java.awt.*; @@ -40,11 +40,8 @@ public class FlowLayoutTextFieldTest extends AbstractGenericTest { @Before public void setUp() throws Exception { - HighlightFactory factory = new HighlightFactory() { - @Override - public Highlight[] getHighlights(String text, int cursorTextOffset) { - return new Highlight[] { new Highlight(4, 4, Color.YELLOW) }; - } + HighlightFactory factory = (field, text, cursorTextOffset) -> { + return new Highlight[] { new Highlight(4, 4, Color.YELLOW) }; }; Font font = new Font("Times New Roman", 0, 14); diff --git a/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/VerticalLayoutTextFieldTest.java b/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/VerticalLayoutTextFieldTest.java index 6d77b473e9..dacf10ab15 100644 --- a/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/VerticalLayoutTextFieldTest.java +++ b/Ghidra/Framework/Docking/src/test/java/docking/widgets/fieldpanel/VerticalLayoutTextFieldTest.java @@ -15,7 +15,7 @@ */ package docking.widgets.fieldpanel; -import static org.junit.Assert.assertEquals; +import static org.junit.Assert.*; import java.awt.*; @@ -40,11 +40,8 @@ public class VerticalLayoutTextFieldTest extends AbstractGenericTest { @Before public void setUp() throws Exception { - HighlightFactory factory = new HighlightFactory() { - @Override - public Highlight[] getHighlights(String text, int cursorTextOffset) { - return new Highlight[] { new Highlight(4, 4, Color.YELLOW) }; - } + HighlightFactory factory = (field, text, cursorTextOffset) -> { + return new Highlight[] { new Highlight(4, 4, Color.YELLOW) }; }; Font font = new Font("Times New Roman", 0, 14); From 89d4c981a74a31cda62f59006fd5cdc793675ce2 Mon Sep 17 00:00:00 2001 From: caheckman Date: Tue, 2 Apr 2019 15:26:15 -0400 Subject: [PATCH 30/35] Reverting decompiler window to have no timeout --- .../java/ghidra/app/decompiler/component/DecompilerManager.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerManager.java b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerManager.java index 617215edb3..f56bba85a7 100644 --- a/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerManager.java +++ b/Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerManager.java @@ -51,7 +51,7 @@ public class DecompilerManager { this.decompilerController = decompilerController; runManager = new RunManager("Decompiler", null); - decompiler = new Decompiler(options, options.getDefaultTimeout()); + decompiler = new Decompiler(options, 0); updateManager = new SwingUpdateManager(500, () -> doPendingDecompile()); } From 21fc990c1570eefbad9964c92cdfe44c547f33bb Mon Sep 17 00:00:00 2001 From: ghidravore Date: Tue, 2 Apr 2019 15:36:37 -0400 Subject: [PATCH 31/35] fixed GT-2719 also updated version number --- Ghidra/Features/Base/data/file_extension_icons.xml | 2 +- Ghidra/application.properties | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Ghidra/Features/Base/data/file_extension_icons.xml b/Ghidra/Features/Base/data/file_extension_icons.xml index 7a3f125c86..9db71c2daf 100644 --- a/Ghidra/Features/Base/data/file_extension_icons.xml +++ b/Ghidra/Features/Base/data/file_extension_icons.xml @@ -22,7 +22,7 @@ - + diff --git a/Ghidra/application.properties b/Ghidra/application.properties index f85257a265..ad0836e18a 100644 --- a/Ghidra/application.properties +++ b/Ghidra/application.properties @@ -1,5 +1,5 @@ application.name=Ghidra -application.version=9.1-DEV +application.version=9.0.2-DEV application.release.name=PUBLIC application.layout.version=1 application.gradle.version=5.0 From 04f3fbba743297cb4a49d90a6c44e6bb2fc8d523 Mon Sep 17 00:00:00 2001 From: ghidravore Date: Tue, 2 Apr 2019 17:39:54 -0400 Subject: [PATCH 32/35] added patch readme --- Ghidra/patch/README.txt | 3 +++ Ghidra/patch/certification.local.manifest | 2 ++ 2 files changed, 5 insertions(+) create mode 100644 Ghidra/patch/README.txt create mode 100644 Ghidra/patch/certification.local.manifest diff --git a/Ghidra/patch/README.txt b/Ghidra/patch/README.txt new file mode 100644 index 0000000000..c80aadd7a0 --- /dev/null +++ b/Ghidra/patch/README.txt @@ -0,0 +1,3 @@ +Drop jar files in this directory to apply patches to an installation of Ghidra. Any jar files +found in this directory will be placed at the front of the classpath, allowing them to override +any existing classes in any module. \ No newline at end of file diff --git a/Ghidra/patch/certification.local.manifest b/Ghidra/patch/certification.local.manifest new file mode 100644 index 0000000000..6018e9ca9f --- /dev/null +++ b/Ghidra/patch/certification.local.manifest @@ -0,0 +1,2 @@ +##VERSION: 2.0 +README.txt||GHIDRA||||END| From 02df1b134cd293baf86bb5428fa74f9ae187e6af Mon Sep 17 00:00:00 2001 From: Ryan Kurtz Date: Wed, 3 Apr 2019 08:13:28 -0400 Subject: [PATCH 33/35] GT-2707: Adding in interfaces and package-level stuff to jsondocs. --- .../BuildFiles/JsonDoclet/src/main/java/JsonDoclet.java | 8 +------- gradleScripts/distribution.gradle | 4 ++++ 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/GhidraBuild/BuildFiles/JsonDoclet/src/main/java/JsonDoclet.java b/GhidraBuild/BuildFiles/JsonDoclet/src/main/java/JsonDoclet.java index 438b7cb42d..eecabab05e 100644 --- a/GhidraBuild/BuildFiles/JsonDoclet/src/main/java/JsonDoclet.java +++ b/GhidraBuild/BuildFiles/JsonDoclet/src/main/java/JsonDoclet.java @@ -39,8 +39,6 @@ import jdk.javadoc.doclet.*; @SuppressWarnings("unchecked") public class JsonDoclet implements Doclet { - private final Set ACCESS_LEVEL = Set.of(Modifier.PUBLIC); - private Reporter log; private File destDir; @@ -122,8 +120,7 @@ public class JsonDoclet implements Doclet { //@formatter:off ElementFilter.typesIn(docEnv.getIncludedElements()) .stream() - .filter(el -> el.getModifiers().containsAll(ACCESS_LEVEL)) - .filter(el -> el.getKind().equals(ElementKind.CLASS)) + .filter(el -> el.getKind().equals(ElementKind.CLASS) || el.getKind().equals(ElementKind.INTERFACE)) .forEach(el -> writeJsonToFile(classToJson(el), el.getQualifiedName())); //@formatter:on @@ -211,9 +208,6 @@ public class JsonDoclet implements Doclet { JSONArray methodArray = new JSONArray(); for (Element el : classElement.getEnclosedElements()) { - if (!el.getModifiers().containsAll(ACCESS_LEVEL)) { - continue; - } JSONObject obj = new JSONObject(); obj.put("name", el.getSimpleName().toString()); diff --git a/gradleScripts/distribution.gradle b/gradleScripts/distribution.gradle index 7aaf03b2f4..15260c088c 100644 --- a/gradleScripts/distribution.gradle +++ b/gradleScripts/distribution.gradle @@ -134,6 +134,10 @@ task createJsondocs(type: Javadoc, description: 'Generate JSON docs for all proj it.sourceSets.test.compileClasspath }) + // Generate at package level because user may try to get help directly on an object they have + // rather than its public interface. + options.addBooleanOption("package", true) + // Some internal packages are not public and need to be exported. options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt.image=ALL-UNNAMED", "java.desktop/sun.awt=ALL-UNNAMED", From a252ec1c1fff6f26b6286b0e3a1c488b0ea64474 Mon Sep 17 00:00:00 2001 From: Ryan Kurtz Date: Wed, 3 Apr 2019 10:27:34 -0400 Subject: [PATCH 34/35] GT-2725: Preventing log4j from using optional jansi.dll on Windows (#286). --- Ghidra/RuntimeScripts/Common/support/launch.properties | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Ghidra/RuntimeScripts/Common/support/launch.properties b/Ghidra/RuntimeScripts/Common/support/launch.properties index 29583412e6..eb7f7a0396 100644 --- a/Ghidra/RuntimeScripts/Common/support/launch.properties +++ b/Ghidra/RuntimeScripts/Common/support/launch.properties @@ -68,3 +68,6 @@ VMARGS=-Dfont.size.override= # generates uncaught exceptions. Disabling it can be helpful when trying to debug what went # wrong because the ContinuesIntercepter affects the usefulness of the stack trace. #VMARGS=-DContinuesInterceptor.disabled + +# Prevent log4j from using the Jansi DLL on Windows. +VMARGS=-Dlog4j.skipJansi=true From 31b449327aba0150876db7f5476436db3e759320 Mon Sep 17 00:00:00 2001 From: ghidra1 Date: Wed, 3 Apr 2019 13:31:19 -0400 Subject: [PATCH 35/35] Updated version to 9.0.2 and restored missing file --- .../src/global/docs/ChangeHistory.html | 39 +++++++++++++++ Ghidra/application.properties | 2 +- GhidraBuild/Skeleton/data/build.xml | 50 +++++++++++++++++++ ... FAMFAMFAM_Mini_Icons_-_Public_Domain.txt} | 0 licenses/certification.manifest | 3 +- 5 files changed, 92 insertions(+), 2 deletions(-) create mode 100644 GhidraBuild/Skeleton/data/build.xml rename licenses/{FAMFAMFAM_MINI_ICONS_-_Public_Domain.txt => FAMFAMFAM_Mini_Icons_-_Public_Domain.txt} (100%) diff --git a/Ghidra/Configurations/Public_Release/src/global/docs/ChangeHistory.html b/Ghidra/Configurations/Public_Release/src/global/docs/ChangeHistory.html index fd9ee62f06..f133714e1a 100644 --- a/Ghidra/Configurations/Public_Release/src/global/docs/ChangeHistory.html +++ b/Ghidra/Configurations/Public_Release/src/global/docs/ChangeHistory.html @@ -6,6 +6,45 @@ + +

      Ghidra 9.0.2 Change History (April 2019)

      + +

      Bugs

      +
      +
        + +
      • Analysis. Constant reference analysis boundary controls for speculative references has been fixed. Speculative references are references created from computed constants passed as parameters, stored to a location, or from indexed offsets from a register. (Issue #228)
        • + +
      • Decompiler. Fixed rendering bug in the Decompiler when the "Find" dialog is closed. (Issue #282)
        • +
      • Decompiler. Fixed decompiler handling of Function Definition data types. (Issue #247)
        • + +
      • Decompiler. Fixed "Free Varnode" exception in RuleConditionalMove. (Issue #294)
        • + +
      • Diff. Fixed exceptions that can occur in the Diff View for programs with overlays.
        • + +
      • Documentation. Corrected the spelling of "listener" throughout the source code. (Issue #235)
        • +
      • Exporter. Exporting a selection as Intel Hex will now allow a selection of any length. Previously this was restricted to multiples of 16 bytes. (Issue #260)
        • +
      • GUI. Fixed exception that occurs after disabling MyProgramChangesDisplayPlugin.
        • + +
      • GUI. Updated the "Open Program" dialog to disallow file drop operations. (Issue #252) + +
      • Languages. The ARM Thumb CMP.W and LSL isntructions have been changed to correctly decode. There are still issues to work out with Unpredictable execution when Rd is the PC. (Issue #280)
        • +
      • Multi-User:Ghidra Server. Corrected bug introduced into ghidraSvr.bat which could prevent Ghidra Server startup (Issue #279)
        • + +
      • Scripting. MultiInstructionMemReference script has been corrected to consider input and output registers when placing a reference on an instruction.
        • + +
      +
      + +

      Security

      +
      +
        + +
      • Basic Infrastructure. Added a property to support/launch.properties to prevent log4j from using jansi.dll on Windows. (Issue #286)
        • + +
      +
      +

      Ghidra 9.0.1 Change History (March 2019)

      New Features

      diff --git a/Ghidra/application.properties b/Ghidra/application.properties index ad0836e18a..d147a5076e 100644 --- a/Ghidra/application.properties +++ b/Ghidra/application.properties @@ -1,5 +1,5 @@ application.name=Ghidra -application.version=9.0.2-DEV +application.version=9.0.2 application.release.name=PUBLIC application.layout.version=1 application.gradle.version=5.0 diff --git a/GhidraBuild/Skeleton/data/build.xml b/GhidraBuild/Skeleton/data/build.xml new file mode 100644 index 0000000000..1e2a6276bc --- /dev/null +++ b/GhidraBuild/Skeleton/data/build.xml @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/licenses/FAMFAMFAM_MINI_ICONS_-_Public_Domain.txt b/licenses/FAMFAMFAM_Mini_Icons_-_Public_Domain.txt similarity index 100% rename from licenses/FAMFAMFAM_MINI_ICONS_-_Public_Domain.txt rename to licenses/FAMFAMFAM_Mini_Icons_-_Public_Domain.txt diff --git a/licenses/certification.manifest b/licenses/certification.manifest index 94ef6577e7..b11781ed93 100644 --- a/licenses/certification.manifest +++ b/licenses/certification.manifest @@ -5,7 +5,8 @@ Christian_Plattner.txt||LICENSE||||END| Creative_Commons_Attribution_2.5.html||LICENSE||||END| Crystal_Clear_Icons_-_LGPL_2.1.txt||LICENSE||||END| FAMFAMFAM_Icons_-_CC_2.5.txt||LICENSE||||END| -FAMFAMFAM_MINI_ICONS_-_Public_Domain.txt||LICENSE||||END| +FAMFAMFAM_Mini_Icons_-_Public_Domain.txt||LICENSE||||END| +FAMFAMFAM Mini Icons - Public Domain.txt||LICENSE||||END| GPL_2_With_Classpath_Exception.txt||LICENSE||||END| JDOM_License.txt||LICENSE||||END| Jython_License.txt||LICENSE||||END|