mirror of
https://github.com/NationalSecurityAgency/ghidra.git
synced 2025-10-05 10:49:34 +02:00
Candidate release of source code.
This commit is contained in:
Dan
parent
db81e6b3b0
commit
79d8f164f8
12449 changed files with 2800756 additions and 16 deletions
255
Ghidra/Features/Decompiler/src/decompile/cpp/options.hh
Normal file
255
Ghidra/Features/Decompiler/src/decompile/cpp/options.hh
Normal file
|
|
@ -0,0 +1,255 @@
|
|||
/* ###
|
||||
* 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.
|
||||
*/
|
||||
/// \file options.hh
|
||||
/// \brief Classes for processing architecture configuration options
|
||||
|
||||
#ifndef __ARCH_OPTIONS__
|
||||
#define __ARCH_OPTIONS__
|
||||
|
||||
#include "error.hh"
|
||||
#include "xml.hh"
|
||||
|
||||
class Architecture;
|
||||
|
||||
/// \brief Base class for options classes that affect the configuration of the Architecture object
|
||||
///
|
||||
/// Each class instance affects configuration through its apply() method, which is handed the
|
||||
/// Architecture object to be configured along with string based parameters. The apply() methods
|
||||
/// are run once during initialization of the Architecture object.
|
||||
class ArchOption {
|
||||
protected:
|
||||
string name; ///< Name of the option
|
||||
public:
|
||||
string getName(void) const { return name; } ///< Return the name of the option
|
||||
|
||||
/// \brief Apply a particular configuration option to the Architecture
|
||||
///
|
||||
/// This method is overloaded by the different Option classes to provide possible configuration
|
||||
/// of different parts of the Architecture. The user can provide up to three optional parameters
|
||||
/// to tailor a specific type of configuration. The method returns a confirmation/failure message
|
||||
/// as feedback.
|
||||
/// \param glb is the Architecture being configured
|
||||
/// \param p1 is the first optional configuration string
|
||||
/// \param p2 is the second optional configuration string
|
||||
/// \param p3 is the third optional configuration string
|
||||
/// \return a confirmation/failure message
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const=0;
|
||||
virtual ~ArchOption(void) {}
|
||||
static bool onOrOff(const string &p); ///< Parse an "on" or "off" string
|
||||
};
|
||||
|
||||
/// \brief A Dispatcher for possible ArchOption commands
|
||||
///
|
||||
/// An \b option \b command is a specific request by a user to change the configuration options
|
||||
/// for an Architecture. This class takes care of dispatching the command to the proper ArchOption
|
||||
/// derived class, which does the work of actually modifying the configuration. The command is issued
|
||||
/// either through the set() method directly, or via an XML tag handed to the restoreXml() method.
|
||||
/// The restoreXml() method expects an \<optionslist> tag with one or more sub-tags. The sub-tag names
|
||||
/// match the registered name of the option and have up to three child tags, \<param1>, \<param2> and \<param3>,
|
||||
/// whose content is provided as the optional parameters to command.
|
||||
class OptionDatabase {
|
||||
Architecture *glb; ///< The Architecture affected by the contained ArchOption
|
||||
map<string,ArchOption *> optionmap; ///< A map from option name to registered ArchOption instance
|
||||
void registerOption(ArchOption *option); ///< Map from ArchOption name to its class instance
|
||||
public:
|
||||
OptionDatabase(Architecture *g); ///< Construct given the owning Architecture
|
||||
~OptionDatabase(void); ///< Destructor
|
||||
string set(const string &nm,const string &p1="",const string &p2="",const string &p3=""); ///< Issue an option command
|
||||
void parseOne(const Element *el); ///< Unwrap and execute a single option XML tag
|
||||
void restoreXml(const Element *el); ///< Execute a series of \e option \e commands passed by XML
|
||||
};
|
||||
|
||||
class OptionExtraPop : public ArchOption {
|
||||
public:
|
||||
OptionExtraPop(void) { name = "extrapop"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionReadOnly : public ArchOption {
|
||||
public:
|
||||
OptionReadOnly(void) { name = "readonly"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionDefaultPrototype : public ArchOption {
|
||||
public:
|
||||
OptionDefaultPrototype(void) { name = "defaultprototype"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionInferConstPtr : public ArchOption {
|
||||
public:
|
||||
OptionInferConstPtr(void) { name = "inferconstptr"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionInline : public ArchOption {
|
||||
public:
|
||||
OptionInline(void) { name = "inline"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionNoReturn : public ArchOption {
|
||||
public:
|
||||
OptionNoReturn(void) { name = "noreturn"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionStructAlign : public ArchOption {
|
||||
public:
|
||||
OptionStructAlign(void) { name = "structalign"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionWarning : public ArchOption {
|
||||
public:
|
||||
OptionWarning(void) { name = "warning"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionNullPrinting : public ArchOption {
|
||||
public:
|
||||
OptionNullPrinting(void) { name = "nullprinting"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionInPlaceOps : public ArchOption {
|
||||
public:
|
||||
OptionInPlaceOps(void) { name = "inplaceops"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionConventionPrinting : public ArchOption {
|
||||
public:
|
||||
OptionConventionPrinting(void) { name = "conventionprinting"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionNoCastPrinting : public ArchOption {
|
||||
public:
|
||||
OptionNoCastPrinting(void) { name = "nocastprinting"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionMaxLineWidth : public ArchOption {
|
||||
public:
|
||||
OptionMaxLineWidth(void) { name = "maxlinewidth"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionIndentIncrement : public ArchOption {
|
||||
public:
|
||||
OptionIndentIncrement(void) { name = "indentincrement"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionCommentIndent : public ArchOption {
|
||||
public:
|
||||
OptionCommentIndent(void) { name = "commentindent"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionCommentStyle : public ArchOption {
|
||||
public:
|
||||
OptionCommentStyle(void) { name = "commentstyle"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionCommentHeader : public ArchOption {
|
||||
public:
|
||||
OptionCommentHeader(void) { name = "commentheader"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionCommentInstruction : public ArchOption {
|
||||
public:
|
||||
OptionCommentInstruction(void) { name = "commentinstruction"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionIntegerFormat : public ArchOption {
|
||||
public:
|
||||
OptionIntegerFormat(void) { name = "integerformat"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionSetAction : public ArchOption {
|
||||
public:
|
||||
OptionSetAction(void) { name = "setaction"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionCurrentAction : public ArchOption {
|
||||
public:
|
||||
OptionCurrentAction(void) { name = "currentaction"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionAllowContextSet : public ArchOption {
|
||||
public:
|
||||
OptionAllowContextSet(void) { name = "allowcontextset"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionIgnoreUnimplemented : public ArchOption {
|
||||
public:
|
||||
OptionIgnoreUnimplemented(void) { name = "ignoreunimplemented"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionErrorUnimplemented : public ArchOption {
|
||||
public:
|
||||
OptionErrorUnimplemented(void) { name = "errorunimplemented"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionErrorReinterpreted : public ArchOption {
|
||||
public:
|
||||
OptionErrorReinterpreted(void) { name = "errorreinterpreted"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionErrorTooManyInstructions : public ArchOption {
|
||||
public:
|
||||
OptionErrorTooManyInstructions(void) { name = "errortoomanyinstructions"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionProtoEval : public ArchOption {
|
||||
public:
|
||||
OptionProtoEval(void) { name = "protoeval"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionSetLanguage : public ArchOption {
|
||||
public:
|
||||
OptionSetLanguage(void) { name = "setlanguage"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionJumpLoad : public ArchOption {
|
||||
public:
|
||||
OptionJumpLoad(void) { name = "jumpload"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
class OptionToggleRule : public ArchOption {
|
||||
public:
|
||||
OptionToggleRule(void) { name = "togglerule"; } ///< Constructor
|
||||
virtual string apply(Architecture *glb,const string &p1,const string &p2,const string &p3) const;
|
||||
};
|
||||
|
||||
#endif
|
||||
Loading…
Add table
Add a link
Reference in a new issue