- Changed Handler.h -> BytecodeHandler.h

- Fixed some small coding standard compliance issues in BytecodeHandler.h


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14393 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Reid Spencer
2004-06-25 02:32:27 +00:00
parent bc7ce7eea4
commit e5c9df6880

View File

@ -1,4 +1,4 @@
//===-- Handler.h - Handle Bytecode Parsing Events --------------*- C++ -*-===// //===-- BytecodeHandler.h - Handle Bytecode Parsing Events ------*- C++ -*-===//
// //
// The LLVM Compiler Infrastructure // The LLVM Compiler Infrastructure
// //
@ -8,15 +8,15 @@
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
// //
// This header file defines the interface to the Bytecode Handler. The handler // This header file defines the interface to the Bytecode Handler. The handler
// is caleld by the Bytecode Reader to obtain out-of-band parsing events for // is called by the Bytecode Reader to obtain out-of-band parsing events for
// tasks other then LLVM IR construction. // tasks other then LLVM IR construction.
// //
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
#ifndef BYTECODE_HANDLER_H #ifndef BYTECODE_BYTECODEHANDLER_H
#define BYTECODE_HANDLER_H #define BYTECODE_BYTECODEHANDLER_H
#include <llvm/Module.h> #include "llvm/Module.h"
namespace llvm { namespace llvm {
@ -31,6 +31,7 @@ class ConstantArray;
/// This class provides a a clear separation of concerns between recognizing /// This class provides a a clear separation of concerns between recognizing
/// the semantic units of a bytecode file (the Reader) and deciding what to do /// the semantic units of a bytecode file (the Reader) and deciding what to do
/// with them (the Handler). /// with them (the Handler).
///
/// The BytecodeReader recognizes the content of the bytecode file and /// The BytecodeReader recognizes the content of the bytecode file and
/// calls the BytecodeHandler methods to let it perform additional tasks. This /// calls the BytecodeHandler methods to let it perform additional tasks. This
/// arrangement allows Bytecode files to be read and handled for a number of /// arrangement allows Bytecode files to be read and handled for a number of
@ -48,7 +49,7 @@ public:
/// @brief Default constructor (empty) /// @brief Default constructor (empty)
BytecodeHandler() {} BytecodeHandler() {}
/// @brief Virtual destructor (empty) /// @brief Virtual destructor (empty)
virtual ~BytecodeHandler() {} virtual ~BytecodeHandler();
private: private:
BytecodeHandler(const BytecodeHandler &); // DO NOT IMPLEMENT BytecodeHandler(const BytecodeHandler &); // DO NOT IMPLEMENT
@ -60,16 +61,16 @@ private:
public: public:
/// This method is called whenever the parser detects an error in the /// This method is called whenever the parser detects an error in the
/// bytecode formatting. Returning true will cause the parser to keep /// bytecode formatting. It gives the handler a chance to do something
/// going, however this is inadvisable in most cases. Returning false will /// with the error message before the parser throws an exception to
/// cause the parser to throw the message as a std::string. /// terminate the parsing.
/// @brief Handle parsing errors. /// @brief Handle parsing errors.
virtual void handleError(const std::string& str ); virtual void handleError(const std::string& str );
/// This method is called at the beginning of a parse before anything is /// This method is called at the beginning of a parse before anything is
/// read in order to give the handler a chance to initialize. /// read in order to give the handler a chance to initialize.
/// @brief Handle the start of a bytecode parse /// @brief Handle the start of a bytecode parse
virtual void handleStart(); virtual void handleStart( unsigned byteSize );
/// This method is called at the end of a parse after everything has been /// This method is called at the end of a parse after everything has been
/// read in order to give the handler a chance to terminate. /// read in order to give the handler a chance to terminate.
@ -79,7 +80,7 @@ public:
/// This method is called at the start of a module to indicate that a /// This method is called at the start of a module to indicate that a
/// module is being parsed. /// module is being parsed.
/// @brief Handle the start of a module. /// @brief Handle the start of a module.
virtual void handleModuleBegin(const std::string& id); virtual void handleModuleBegin(const std::string& moduleId);
/// This method is called at the end of a module to indicate that the module /// This method is called at the end of a module to indicate that the module
/// previously being parsed has concluded. /// previously being parsed has concluded.
@ -123,8 +124,7 @@ public:
/// This method is called when the function prototype for a function is /// This method is called when the function prototype for a function is
/// encountered in the module globals block. /// encountered in the module globals block.
virtual void handleFunctionDeclaration( virtual void handleFunctionDeclaration(
Function* Func, ///< The function being declared Function* Func ///< The function being declared
const FunctionType* FuncType ///< The type of the function
); );
/// This method is called at the end of the module globals block. /// This method is called at the end of the module globals block.