yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-04 18:29:37 +02:00
Code Issues Releases Wiki Activity

javadoc html5

Browse source
This commit is contained in:
astrelsky 2019-12-12 22:47:09 -05:00
parent 3eb130123b
commit 3bdf049d44
No known key found for this signature in database
GPG key ID: FA88FA97D6877C37
136 changed files with 428 additions and 425 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Ghidra/Framework/Utility/src/main/java/generic/jar/ResourceFile.java
View file

@ -225,7 +225,7 @@ public class ResourceFile implements Comparable<ResourceFile> {
* Returns a File object. If this ResourceFile represents a standard filesystem, then no
* copy is necessary to return a file. If this ResourceFile represents a compressed
* filesystem, then a copy from that filesystem to the real filesystem is needed to create
* a File object. <tt>copyIfNeeded</tt> allows you to dictate whether a copy should take
* a File object. <code>copyIfNeeded</code> allows you to dictate whether a copy should take
* place, if needed.
* <p>
* If you just want the contents of a file, then call {@link #getInputStream()}.

4
Ghidra/Framework/Utility/src/main/java/ghidra/util/MonitoredOutputStream.java
View file

@ -52,9 +52,9 @@ public class MonitoredOutputStream extends OutputStream {
* <p>
* The <code>write</code> method of <code>FilterOutputStream</code>
* calls the <code>write</code> method of its underlying output stream,
* that is, it performs <tt>out.write(b)</tt>.
* that is, it performs <code>out.write(b)</code>.
* <p>
* Implements the abstract <tt>write</tt> method of <tt>OutputStream</tt>.
* Implements the abstract <code>write</code> method of <code>OutputStream</code>.
*
* @param b the <code>byte</code>.
* @exception IOException if an I/O error occurs.

2
Ghidra/Framework/Utility/src/main/java/ghidra/util/Msg.java
View file

@ -22,7 +22,7 @@ import java.awt.Component;
* more detailed message (e.g., stacktrace).
*
* <P>The 'message' parameter for these calls is typically a String. However, it can also
* be a log4j <tt>Message</tt> object as well. (See log4j2 for details.)
* be a log4j <code>Message</code> object as well. (See log4j2 for details.)
*/
public class Msg {
private static ErrorLogger errorLogger = new DefaultErrorLogger();

4
Ghidra/Framework/Utility/src/main/java/ghidra/util/SystemUtilities.java
View file

@ -152,7 +152,7 @@ public class SystemUtilities {
/**
* Checks to see if the font size override setting is enabled and adjusts
* the given font as necessary to match the override setting. If the setting
* is not enabled, then <tt>font</tt> is returned.
* is not enabled, then <code>font</code> is returned.
*
* @param font
* The current font to adjust, if necessary.
@ -408,7 +408,7 @@ public class SystemUtilities {
* This method is useful to print values of code that you cannot edit while debugging.
* <p>
* Example, inside of your conditional breakpoint for a method on a Sun Java file you
* can put something like: <tt>printString("Value of first arg: " + arg0, System.err)</tt>
* can put something like: <code>printString("Value of first arg: " + arg0, System.err)</code>
* <p>
* Note: Don't remove this method simply because no code is referencing it, as it is used
* by conditional breakpoints.

10
Ghidra/Framework/Utility/src/main/java/utilities/util/FileUtilities.java
View file

@ -493,8 +493,8 @@ public final class FileUtilities {
}
/**
* Copies the contents of <tt>originalDir</tt> to <tt>copyDir</tt>. If the <tt>originalDir</tt>
* does not exist, then this method will do nothing. If <tt>copyDir</tt> does not exist, then
* Copies the contents of <code>originalDir</code> to <code>copyDir</code>. If the <code>originalDir</code>
* does not exist, then this method will do nothing. If <code>copyDir</code> does not exist, then
* it will be created as necessary.
*
* @param originalDir The directory from which to extract contents
@ -635,7 +635,7 @@ public final class FileUtilities {
}
/**
* Copy the <tt>in</tt> stream to the <tt>out</tt> stream. The output stream will
* Copy the <code>in</code> stream to the <code>out</code> stream. The output stream will
* <b>not</b> be closed when the copy operation is finished.
*
* @param in source input stream
@ -843,7 +843,7 @@ public final class FileUtilities {
/**
* Returns true if the given file:
* <ol>
* <li> is <tt>null</tt>, or </li>
* <li> is <code>null</code>, or </li>
* <li>{@link File#isFile()} is true, </li>
* <li>and {@link File#length()} is == 0.</li>
* </ol>
@ -890,7 +890,7 @@ public final class FileUtilities {
* the paths are the same or unrelated, then null is returned.
*
* <P>For example, given, in this order, two files with these paths
* <tt>/a/b</tt> and <tt>/a/b/c</tt>, this method will return 'c'.
* <code>/a/b</code> and <code>/a/b/c</code>, this method will return 'c'.
*
* @param f1 the parent file
* @param f2 the child file

24
Ghidra/Framework/Utility/src/main/java/utilities/util/reflection/ReflectionUtilities.java
View file

@ -42,9 +42,9 @@ public class ReflectionUtilities {
}
/**
* Locates the field of the name <tt>fieldName</tt> on the given
* Locates the field of the name <code>fieldName</code> on the given
* class. If the given class does not contain the field, then this
* method will recursively call up <tt>containingClass</tt>'s
* method will recursively call up <code>containingClass</code>'s
* implementation tree looking for a parent implementation of the
* requested field.
*
@ -73,9 +73,9 @@ public class ReflectionUtilities {
}
/**
* Locates the field of the name <tt>fieldName</tt> on the given
* Locates the field of the name <code>fieldName</code> on the given
* class. If the given class does not contain the field, then this
* method will recursively call up <tt>containingClass</tt>'s
* method will recursively call up <code>containingClass</code>'s
* implementation tree looking for a parent implementation of the
* requested field.
*
@ -104,9 +104,9 @@ public class ReflectionUtilities {
}
/**
* Locates the method of the name <tt>methodName</tt> on the given
* Locates the method of the name <code>methodName</code> on the given
* class. If the given class does not contain the method, then this
* method will recursively call up <tt>containingClass</tt>'s
* method will recursively call up <code>containingClass</code>'s
* implementation tree looking for a parent implementation of the
* requested method.
*
@ -294,9 +294,9 @@ public class ReflectionUtilities {
}
/**
* Uses the given <tt>patterns</tt> to remove elements from the given stack trace.
* The current implementation will simply perform a <tt>toString()</tt> on each element and
* then check to see if that string contains any of the <tt>patterns</tt>.
* Uses the given <code>patterns</code> to remove elements from the given stack trace.
* The current implementation will simply perform a <code>toString()</code> on each element and
* then check to see if that string contains any of the <code>patterns</code>.
*
* @param trace the trace to filter
* @param patterns the non-regex patterns used to perform a
@ -423,7 +423,7 @@ public class ReflectionUtilities {
* classes. Further, interface hierarchies are examined before concrete parent extensions.
* <p>
* If the given items have no parents in common, then the result will be a list with
* only <tt>Object.class</tt>.
* only <code>Object.class</code>.
*
* @param list the items to examine
* @return the set of items
@ -466,7 +466,7 @@ public class ReflectionUtilities {
* classes. Further, interface hierarchies are examined before concrete parent extensions.
* <p>
* If the given items have no parents in common, then the result will be a list with
* only <tt>Object.class</tt>.
* only <code>Object.class</code>.
*
* @param list the items to examine
* @return the set of items
@ -526,7 +526,7 @@ public class ReflectionUtilities {
* Returns an order set of all interfaces implemented and classes extended for the entire
* type structure of the given class.
* <p>
* If <tt>Object.class</tt> is passed to this method, then it will be returned in the
* If <code>Object.class</code> is passed to this method, then it will be returned in the
* result of this method.
*
* @param c the class to introspect

8
Ghidra/Framework/Utility/src/main/java/utility/function/Callback.java
View file

@ -23,7 +23,7 @@ package utility.function;
public interface Callback {
/**
* Creates a dummy callback function. This is useful to avoid using <tt>null</tt>.
* Creates a dummy callback function. This is useful to avoid using <code>null</code>.
* @return a dummy callback function
*/
public static Callback dummy() {
@ -33,10 +33,10 @@ public interface Callback {
}
/**
* Returns the given callback object if it is not <tt>null</tt>. Otherwise, a {@link #dummy()}
* callback is returned. This is useful to avoid using <tt>null</tt>.
* Returns the given callback object if it is not <code>null</code>. Otherwise, a {@link #dummy()}
* callback is returned. This is useful to avoid using <code>null</code>.
*
* @param c the callback function to check for <tt>null</tt>
* @param c the callback function to check for <code>null</code>
* @return a non-null callback function
*/
public static Callback dummyIfNull(Callback c) {

34
Ghidra/Framework/Utility/src/main/java/utility/module/ModuleUtilities.java
View file

@ -206,18 +206,18 @@ public class ModuleUtilities {
/**
* Returns true if the given path is parented by a module root directory.
* <p>
* For example, given a module path of <tt>/some/dir/features/cool_module/</tt>, then this
* For example, given a module path of <code>/some/dir/features/cool_module/</code>, then this
* method will return true for these paths:
* <br>
* <br>
* <tt>/some/dir/features/cool_module</tt><br>
* <tt>/some/dir/features/cool_module/some/child/dir</tt>
* <code>/some/dir/features/cool_module</code><br>
* <code>/some/dir/features/cool_module/some/child/dir</code>
* <br>
* <br>and false for these paths:
* <br>
* <br>
* <tt>/some/random/path</tt><br>
* <tt>/some/dir/features/</tt>
* <code>/some/random/path</code><br>
* <code>/some/dir/features/</code>
*
* @param pathName the path name to check
* @return true if the given path is parented by a module root directory.
@ -231,18 +231,18 @@ public class ModuleUtilities {
* Returns the path of the module containing the given path string, if it is parented by a
* module root directory.
* <p>
* For example, given a module path of <tt>/some/dir/features/cool_module/</tt>, then this
* For example, given a module path of <code>/some/dir/features/cool_module/</code>, then this
* method will return that module path, given these paths:
* <br>
* <br>
* <tt>/some/dir/features/cool_module</tt><br>
* <tt>/some/dir/features/cool_module/some/child/dir</tt>
* <code>/some/dir/features/cool_module</code><br>
* <code>/some/dir/features/cool_module/some/child/dir</code>
* <br>
* <br>and null for these paths:
* <br>
* <br>
* <tt>/some/random/path</tt><br>
* <tt>/some/dir/features/</tt>
* <code>/some/random/path</code><br>
* <code>/some/dir/features/</code>
*
* @param pathName the path name to check
* @return the module root directory; null if the path is not in a module
@ -274,13 +274,13 @@ public class ModuleUtilities {
* here means a folder that contains a repository folder. As an example, given a repo
* structure of:
*
* <p><tt>/userdir/repoRoot/repoDir/.git</tt><br>
* <p><code>/userdir/repoRoot/repoDir/.git</code><br>
*
* <p>then this method, given will produce the following results (input -&gt; output):<br>
*
* <p><tt>/userdir/repoRoot/repoDir/.git -&gt; /userdir/repoRoot</tt>
* <br><tt>/userdir/repoRoot/repoDir -&gt; /userdir/repoRoot</tt>
* <br><tt>/userdir/repoRoot -&gt; /userdir/repoRoot</tt>
* <p><code>/userdir/repoRoot/repoDir/.git -&gt; /userdir/repoRoot</code>
* <br><code>/userdir/repoRoot/repoDir -&gt; /userdir/repoRoot</code>
* <br><code>/userdir/repoRoot -&gt; /userdir/repoRoot</code>
*
*
* @param f the child file of the desired repo
@ -314,12 +314,12 @@ public class ModuleUtilities {
* Returns a file that is the repository folder containing the given file. As an example,
* given a repo structure of:
*
* <p><tt>/userdir/repoRoot/repoDir/.git</tt><br>
* <p><code>/userdir/repoRoot/repoDir/.git</code><br>
*
* <p>then this method, given will produce the following results (input -&gt; output):<br>
*
* <p><tt>/userdir/repoRoot/repoDir/.git -&gt; /userdir/repoRoot/repoDir</tt>
* <br><tt>/userdir/repoRoot/repoDir -&gt; /userdir/repoRoot/repoDir</tt>
* <p><code>/userdir/repoRoot/repoDir/.git -&gt; /userdir/repoRoot/repoDir</code>
* <br><code>/userdir/repoRoot/repoDir -&gt; /userdir/repoRoot/repoDir</code>
*
* @param f the child file of the desired repo
* @return a file that is the repo folder of the repository containing the given file; null