CodeGen
[ class tree: CodeGen ] [ index: CodeGen ] [ all elements ]
Packages:
CodeGen


Classes:
CodeGen_Command
CodeGen_Element
CodeGen_Extension
CodeGen_ExtensionParser
CodeGen_License
CodeGen_License_BSD
CodeGen_License_LGPL
CodeGen_License_PHP
CodeGen_Maintainer
CodeGen_Release
CodeGen_Tools_Getopt
CodeGen_Tools_Indent
CodeGen_Tools_Outbuf
CodeGen_Tools_Platform
CodeGen_Tools_Tokenizer
CodeGen_XmlParser
Files:
BSD.php
Code.php
Command.php
Element.php
Extension.php
ExtensionParser.php
Getopt.php
Indent.php
LGPL.php
License.php
Maintainer.php
Outbuf.php
PHP.php
Platform.php
Release.php
Tokenizer.php
XmlParser.php

Element index for package CodeGen

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ x ] [ _ ]

_

__construct
in file Release.php, method CodeGen_Release::__construct()
    Constructor
__construct
in file Tokenizer.php, method CodeGen_Tools_Tokenizer::__construct()
    Konstruktor
__construct
in file XmlParser.php, method CodeGen_XmlParser::__construct()
    The constructor
__construct
in file Platform.php, method CodeGen_Tools_Platform::__construct()
    Constructor gets a list of names or "all"
__construct
in file Outbuf.php, method CodeGen_Tools_Outbuf::__construct()
    Constructor
__construct
in file ExtensionParser.php, method CodeGen_ExtensionParser::__construct()
    Constructor
__construct
in file Getopt.php, method CodeGen_Tools_Getopt::__construct()
    Constructor will parse specified short and long arguments
__construct
in file Maintainer.php, method CodeGen_Maintainer::__construct()
    Constructor
__construct
in file Command.php, method CodeGen_Command::__construct()
    Command constructor
__destruct
in file Outbuf.php, method CodeGen_Tools_Outbuf::__destruct()
    Destructor -> write file
top

a

$authors
in file Extension.php, variable CodeGen_Extension::$authors
    The authors contributing to this extension
addAuthor
in file Extension.php, method CodeGen_Extension::addAuthor()
    Add an author or maintainer to the extension
arguments
in file Getopt.php, method CodeGen_Tools_Getopt::arguments()
    Get all additional arguments not bound to options
top

b

BSD.php
procedural page BSD.php
top

c

$comment_prefix
in file Maintainer.php, variable CodeGen_Maintainer::$comment_prefix
    Prefix to use in comment headers
cCode
in file Element.php, method CodeGen_Element::cCode()
    Generate C code for element
cCodeEditorSettings
in file Element.php, method CodeGen_Element::cCodeEditorSettings()
    Generate Editor settings block for C source files
cCodeFooter
in file Element.php, method CodeGen_Element::cCodeFooter()
    Generate C code footer block for all elements of this class
cCodeHeader
in file Element.php, method CodeGen_Element::cCodeHeader()
    Generate C code header block for all elements of this class
checkAttributes
in file XmlParser.php, method CodeGen_XmlParser::checkAttributes()
    Check attributes
Command.php
procedural page Command.php
Code.php
procedural page Code.php
CodeGen_Command
in file Command.php, class CodeGen_Command
    Command wrapper class
CodeGen_Element
in file Element.php, class CodeGen_Element
    Abstract base class for all code elements
CodeGen_Extension
in file Extension.php, class CodeGen_Extension
    Extension generator class
CodeGen_ExtensionParser
in file ExtensionParser.php, class CodeGen_ExtensionParser
    Parser for XML based extension desription files
CodeGen_License
in file License.php, class CodeGen_License
    Abstract base class for licenses
CodeGen_License_BSD
in file BSD.php, class CodeGen_License_BSD
    The BSD License
CodeGen_License_LGPL
in file LGPL.php, class CodeGen_License_LGPL
    The LGPL License
CodeGen_License_PHP
in file PHP.php, class CodeGen_License_PHP
    The PHP License
CodeGen_Maintainer
in file Maintainer.php, class CodeGen_Maintainer
    A class that describes an extension author or maintainer
CodeGen_Release
in file Release.php, class CodeGen_Release
    Class collecting release information
CodeGen_Tools_Getopt
in file Getopt.php, class CodeGen_Tools_Getopt
    A more convenient command line argument parser class
CodeGen_Tools_Indent
in file Indent.php, class CodeGen_Tools_Indent
    Wrapper class for whitespace related stuff
CodeGen_Tools_Outbuf
in file Outbuf.php, class CodeGen_Tools_Outbuf
    Output buffer handling class
CodeGen_Tools_Platform
in file Platform.php, class CodeGen_Tools_Platform
    A helper class for platform management
CodeGen_Tools_Tokenizer
in file Tokenizer.php, class CodeGen_Tools_Tokenizer
    A simple tokenizer for e.g. proto parsing
CodeGen_XmlParser
in file XmlParser.php, class CodeGen_XmlParser
    Yet another XML parsing class
commandOptions
in file Command.php, method CodeGen_Command::commandOptions()
    Define the available command line options
comment
in file Maintainer.php, method CodeGen_Maintainer::comment()
    Generate a comment header line for this author
count
in file Platform.php, method CodeGen_Tools_Platform::count()
    Count the number of supported platforms
top

d

$date
in file Release.php, variable CodeGen_Release::$date
    The release date
$description
in file Extension.php, variable CodeGen_Extension::$description
    extension description
$done
in file Tokenizer.php, variable CodeGen_Tools_Tokenizer::$done
    Parsing complete?
docEditorSettings
in file Element.php, method CodeGen_Element::docEditorSettings()
    Generate Editor settings block for documentation files
docEntry
in file Element.php, method CodeGen_Element::docEntry()
    Generate documentation code for element
docFooter
in file Element.php, method CodeGen_Element::docFooter()
    Generate documentation footer block for all elements of this class
docHeader
in file Element.php, method CodeGen_Element::docHeader()
    Generate documentation header block for all elements of this class
dosify
in file Indent.php, method CodeGen_Tools_Indent::dosify()
    Change to DOS/Windows line terminators
top

e

$email
in file Maintainer.php, variable CodeGen_Maintainer::$email
    Email address
$extension
in file Command.php, variable CodeGen_Command::$extension
    The extension the command class is going to work on
Element.php
procedural page Element.php
Extension.php
procedural page Extension.php
ExtensionParser.php
procedural page ExtensionParser.php
errorHandler
in file Command.php, method CodeGen_Command::errorHandler()
    Error handler callback
execute
in file Command.php, method CodeGen_Command::execute()
    Create extension using the given parser
extEntityHandler
in file XmlParser.php, method CodeGen_XmlParser::extEntityHandler()
top

f

$filename
in file XmlParser.php, variable CodeGen_XmlParser::$filename
    Input Filename
$first
in file Maintainer.php, variable CodeGen_Maintainer::$first
    First maintainer added?
$fp
in file XmlParser.php, variable CodeGen_XmlParser::$fp
    Input stream
factory
in file License.php, method CodeGen_License::factory()
    Takes a License shortname and returns an instantiated object of that license
top

g

Getopt.php
procedural page Getopt.php
getChangelog
in file Extension.php, method CodeGen_Extension::getChangelog()
    changelog getter
getComment
in file LGPL.php, method CodeGen_License_LGPL::getComment()
    License comment to include in code files
getComment
in file PHP.php, method CodeGen_License_PHP::getComment()
    License comment to include in code files
getComment
in file BSD.php, method CodeGen_License_BSD::getComment()
    License comment to include in code files
getDate
in file Release.php, method CodeGen_Release::getDate()
    date getter
getLanguage
in file Extension.php, method CodeGen_Extension::getLanguage()
    Get programming language
getName
in file LGPL.php, method CodeGen_License_LGPL::getName()
    Get full name
getName
in file PHP.php, method CodeGen_License_PHP::getName()
    Get full name
getName
in file Maintainer.php, method CodeGen_Maintainer::getName()
    real name getter
getName
in file License.php, method CodeGen_License::getName()
    Returns the full license name
getName
in file BSD.php, method CodeGen_License_BSD::getName()
    Get full name
getName
in file Extension.php, method CodeGen_Extension::getName()
    Get extension base name
getNotes
in file Release.php, method CodeGen_Release::getNotes()
    notes getter
getPrefix
in file Extension.php, method CodeGen_Extension::getPrefix()
    Get extension name prefix
getShortName
in file PHP.php, method CodeGen_License_PHP::getShortName()
    Get short name
getShortName
in file BSD.php, method CodeGen_License_BSD::getShortName()
    Get short name
getShortName
in file LGPL.php, method CodeGen_License_LGPL::getShortName()
    Get short name
getShortName
in file License.php, method CodeGen_License::getShortName()
    Returns the sort license name
getState
in file Release.php, method CodeGen_Release::getState()
    state getter
getText
in file PHP.php, method CodeGen_License_PHP::getText()
    Complete License Text
getText
in file LGPL.php, method CodeGen_License_LGPL::getText()
    Complete License Text
getText
in file License.php, method CodeGen_License::getText()
    Returns the complete license text as string
getText
in file BSD.php, method CodeGen_License_BSD::getText()
    Complete License Text
getURI
in file LGPL.php, method CodeGen_License_LGPL::getURI()
    Get License URI
getURI
in file PHP.php, method CodeGen_License_PHP::getURI()
    Get License URI
getUri
in file License.php, method CodeGen_License::getUri()
    Returns an URI that points to the license text or an online description
getUser
in file Maintainer.php, method CodeGen_Maintainer::getUser()
    CVS user getter
getVersion
in file Release.php, method CodeGen_Release::getVersion()
    version getter
top

h

have
in file Getopt.php, method CodeGen_Tools_Getopt::have()
    Check if any of the specified options was given
haveAll
in file Getopt.php, method CodeGen_Tools_Getopt::haveAll()
    Check if all of the specified options were given
hCode
in file Element.php, method CodeGen_Element::hCode()
    Generate C include file definitions for element
top

i

Indent.php
procedural page Indent.php
indent
in file Indent.php, method CodeGen_Tools_Indent::indent()
    re-indent a block of text
isKeyword
in file Element.php, method CodeGen_Element::isKeyword()
    Checks whether a string is a reserved name
isName
in file Element.php, method CodeGen_Element::isName()
    Checks whether a string is a valid C name
top

l

$language
in file Extension.php, variable CodeGen_Extension::$language
    The implementation language
$license
in file Extension.php, variable CodeGen_Extension::$license
    The license for this extension
LGPL.php
procedural page LGPL.php
License.php
procedural page License.php
linetrim
in file Indent.php, method CodeGen_Tools_Indent::linetrim()
    Trim of leading and trailing whitespace-only lines
top

m

Maintainer.php
procedural page Maintainer.php
top

n

$name
in file Extension.php, variable CodeGen_Extension::$name
    The extensions basename (C naming rules apply)
$name
in file Maintainer.php, variable CodeGen_Maintainer::$name
    Real name
newParser
in file XmlParser.php, method CodeGen_XmlParser::newParser()
nextToken
in file Tokenizer.php, method CodeGen_Tools_Tokenizer::nextToken()
    Read next token into $this->type, $this->token
top

o

Outbuf.php
procedural page Outbuf.php
OB_DOSIFY
in file Outbuf.php, class constant CodeGen_Tools_Outbuf::OB_DOSIFY
    Flag bits
OB_TABIFY
in file Outbuf.php, class constant CodeGen_Tools_Outbuf::OB_TABIFY
OB_UNTABIFY
in file Outbuf.php, class constant CodeGen_Tools_Outbuf::OB_UNTABIFY
options
in file Getopt.php, method CodeGen_Tools_Getopt::options()
    Get all given option names
top

p

$platform
in file Extension.php, variable CodeGen_Extension::$platform
    The target platform for this extension
$pos
in file Tokenizer.php, variable CodeGen_Tools_Tokenizer::$pos
    Current parsing position
$prefix
in file Extension.php, variable CodeGen_Extension::$prefix
    Name prefix for functions etc.
PHP.php
procedural page PHP.php
Platform.php
procedural page Platform.php
parse
in file XmlParser.php, method CodeGen_XmlParser::parse()
    Perform the actual parsing
popParser
in file XmlParser.php, method CodeGen_XmlParser::popParser()
posString
in file XmlParser.php, method CodeGen_XmlParser::posString()
pushParser
in file XmlParser.php, method CodeGen_XmlParser::pushParser()
pushToken
in file Tokenizer.php, method CodeGen_Tools_Tokenizer::pushToken()
    Push back a parsed token
top

r

$release
in file Extension.php, variable CodeGen_Extension::$release
    The release info for this extension
$role
in file Maintainer.php, variable CodeGen_Maintainer::$role
    Role in this project
Release.php
procedural page Release.php
top

s

$state
in file Release.php, variable CodeGen_Release::$state
    The 'state': alpha, beta, stable, devel ...
$string
in file Tokenizer.php, variable CodeGen_Tools_Tokenizer::$string
    String to parse
$summary
in file Extension.php, variable CodeGen_Extension::$summary
    The extensions descriptive name
setChangelog
in file Extension.php, method CodeGen_Extension::setChangelog()
    Set method for changelog
setDate
in file Release.php, method CodeGen_Release::setDate()
    Set method for release date
setDescription
in file Extension.php, method CodeGen_Extension::setDescription()
    Set extension documentation text
setEmail
in file Maintainer.php, method CodeGen_Maintainer::setEmail()
    Set email address
setInputFile
in file XmlParser.php, method CodeGen_XmlParser::setInputFile()
    Set file to parse
setLanguage
in file Extension.php, method CodeGen_Extension::setLanguage()
    Set the programming language to produce code for
setLicense
in file Extension.php, method CodeGen_Extension::setLicense()
    Set license
setName
in file Maintainer.php, method CodeGen_Maintainer::setName()
    Set real user name
setName
in file Extension.php, method CodeGen_Extension::setName()
    Set extension base name
setNotes
in file Release.php, method CodeGen_Release::setNotes()
    Set method for release notes
setPlatform
in file Extension.php, method CodeGen_Extension::setPlatform()
    Set target platform for generated code
setPrefix
in file Extension.php, method CodeGen_Extension::setPrefix()
    Set extension name prefix (for functions etc.)
setRelease
in file Extension.php, method CodeGen_Extension::setRelease()
    Set release info
setRole
in file Maintainer.php, method CodeGen_Maintainer::setRole()
    Set project role
setState
in file Release.php, method CodeGen_Release::setState()
    Set method for state
setSummary
in file Extension.php, method CodeGen_Extension::setSummary()
    Set extension summary text
setUser
in file Maintainer.php, method CodeGen_Maintainer::setUser()
    Set CVS user name
setVersion
in file Release.php, method CodeGen_Release::setVersion()
    Set method for version number
showUsage
in file Command.php, method CodeGen_Command::showUsage()
    Show usage/help message
showVersion
in file Command.php, method CodeGen_Command::showVersion()
    Show copyright and version info taken from extension class
top

t

$token
in file Tokenizer.php, variable CodeGen_Tools_Tokenizer::$token
    Current token content
$type
in file Tokenizer.php, variable CodeGen_Tools_Tokenizer::$type
    Current token type (name, numeric, string)
Tokenizer.php
procedural page Tokenizer.php
tabify
in file Indent.php, method CodeGen_Tools_Indent::tabify()
    Replace leading blanks with tabs
tagend_extension_changelog
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_extension_changelog()
tagend_extension_release
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_extension_release()
tagend_license
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_license()
tagend_maintainer
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_maintainer()
tagend_maintainers
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_maintainers()
tagend_maintainer_email
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_maintainer_email()
tagend_maintainer_name
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_maintainer_name()
tagend_maintainer_role
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_maintainer_role()
tagend_maintainer_user
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_maintainer_user()
tagend_release_date
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_release_date()
tagend_release_notes
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_release_notes()
tagend_release_state
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_release_state()
tagend_release_version
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagend_release_version()
tagstart_extension_changelog
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagstart_extension_changelog()
tagstart_extension_release
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagstart_extension_release()
tagstart_maintainer
in file ExtensionParser.php, method CodeGen_ExtensionParser::tagstart_maintainer()
terminate
in file Command.php, method CodeGen_Command::terminate()
    Show error message and bailout
test
in file Platform.php, method CodeGen_Tools_Platform::test()
    Test for a platform shortname
toBool
in file XmlParser.php, method CodeGen_XmlParser::toBool()
    accept various truth values
top

u

$user
in file Maintainer.php, variable CodeGen_Maintainer::$user
    Users system account name
untabify
in file Indent.php, method CodeGen_Tools_Indent::untabify()
    Replace leading tabs with blanks
top

v

$verbatim
in file XmlParser.php, variable CodeGen_XmlParser::$verbatim
    Verbatim indicator
$verbatimDepth
in file XmlParser.php, variable CodeGen_XmlParser::$verbatimDepth
    Verbatim taglevel depth
$version
in file Release.php, variable CodeGen_Release::$version
    The current version number
value
in file Getopt.php, method CodeGen_Tools_Getopt::value()
    Get argument value for an option
verbatim
in file XmlParser.php, method CodeGen_XmlParser::verbatim()
    Start verbatim mode
top

w

writeToFile
in file License.php, method CodeGen_License::writeToFile()
    Writes the License text to a file
top

x

XmlParser.php
procedural page XmlParser.php
top
Documentation generated on Mon, 11 Mar 2019 14:16:01 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.