Overview

Namespaces

  • None
  • Peg
    • Cli
      • Commands
    • Config
    • Custom
      • Command
        • Action
          • Generate
          • Parse
      • CommandLine
      • Config
      • Localization
      • Utilities
    • Lib
      • Definitions
        • Element
      • Generator
      • Lexers
      • Plugins
      • Signals
        • Data
          • Definitions
          • Lexers
        • Type
  • PHP

Classes

  • Base
  • Doxygen
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class Base

Declares the base for a parse action that extract and generates definition files.

Peg\Custom\CommandLine\Action
Extended by Peg\Custom\Command\Action\Parse\Base

Direct known subclasses

Peg\Custom\Command\Action\Parse\Doxygen
Abstract
Namespace: Peg\Custom\Command\Action\Parse
Located at src/Command/Action/Parse/Base.php
Methods summary
public
# __construct( string $input_format )

You derived class should override this and set the input_format name of your parser/lexer so it is called apropiately when this variable is set.

You derived class should override this and set the input_format name of your parser/lexer so it is called apropiately when this variable is set.

Parameters

$input_format
string
$input_format Format of files to parse, eg: doxygen
public
# OnCall( Peg\Custom\CommandLine\Command $command )

You shouldn't override this method, instead write a Start() implementation.

You shouldn't override this method, instead write a Start() implementation.

Parameters

$command
Peg\Custom\CommandLine\Command
$command
abstract public
# Start( mixed $path )

Needs to be implemented by classes extending this one in order to begin the parsing process when the input format matches that of the action been called.

Needs to be implemented by classes extending this one in order to begin the parsing process when the input format matches that of the action been called.

Properties summary
protected Peg\Custom\CommandLine\Command $command
#

Reference to command that called this action.

Reference to command that called this action.

protected string $input_format
#

Format of the files to parse/lex.

Format of the files to parse/lex.

protected string $output_format
#

Format used to store the parsed definition files.

Format used to store the parsed definition files.

See

Peg\Lib\Definitions\Type
protected string $headers_path
#

This is used optionally by a children implementing this class in order for them to correctly resolve a header file. For example: doxygen xml files store the full path to the header file where a symbol was found, eg: /home/user/libs/wx/frame.h, if this variable is set to /home/user/libs/ the final header file will be stored on the symbols object as wx/frame.h

This is used optionally by a children implementing this class in order for them to correctly resolve a header file. For example: doxygen xml files store the full path to the header file where a symbol was found, eg: /home/user/libs/wx/frame.h, if this variable is set to /home/user/libs/ the final header file will be stored on the symbols object as wx/frame.h

protected boolean $verbose
#

Flag that indicates if the lexer/parser should output messages of its current status.

Flag that indicates if the lexer/parser should output messages of its current status.

PEG Api API documentation generated by ApiGen 2.8.0