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

Packages:
CodeGen

Classes:

CodeGen_Command
CodeGen_Dependency_Header
CodeGen_Dependency_Lib
CodeGen_Element
CodeGen_Extension
CodeGen_ExtensionParser
CodeGen_License
CodeGen_License_BSD
CodeGen_License_GPL
CodeGen_License_LGPL
CodeGen_License_PHP
CodeGen_Maintainer
CodeGen_Release
CodeGen_Tools_Code
CodeGen_Tools_FileReplacer
CodeGen_Tools_Getopt
CodeGen_Tools_Indent
CodeGen_Tools_IndentC
CodeGen_Tools_Outbuf
CodeGen_Tools_Platform
CodeGen_Tools_Tokenizer
CodeGen_XmlParser

Files:

BSD.php
Code.php
Command.php
Element.php
Extension.php
ExtensionParser.php
FileReplacer.php
Getopt.php
GPL.php
Header.php
Indent.php
IndentC.php
LGPL.php
Lib.php
License.php
Maintainer.php
Outbuf.php
PHP.php
Platform.php
Release.php
Tokenizer.php
XmlParser.php

Class: CodeGen_Element

Source Location: /CodeGen-1.0.3/CodeGen/Element.php

Class Overview

Abstract base class for all code elements

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005 Hartmut Holzgraefe

Variables

Methods

Child classes:

CodeGen_Dependency_Lib: Class representing a library dependencyp

CodeGen_Dependency_Header: Class representing a header file dependency

Inherited Variables

Inherited Methods

Class Details

[line 33]
Abstract base class for all code elements

Author: Hartmut Holzgraefe <hartmut@php.net>
Version: Release: @package_version@
Copyright: 2005 Hartmut Holzgraefe
Link: http://pear.php.net/package/CodeGen
Abstract:
License: PHP License 3.0

[ Top ]

Class Variables

$description = ""

[line 94]

A long description

Access: protected

Type: string

[ Top ]

$ifCondition = ""

[line 115]

Conditional compile condition

Access: protected

Type: string

[ Top ]

$name = "unknown"

[line 40]

The function name

Access: protected

Type: string

[ Top ]

$summary = ""

[line 72]

A short description

Access: protected

Type: string

[ Top ]

Method Detail

cCode [line 204]

string cCode(
string
$name)

Generate C code for element

Return: C code
Access: public

Parameters:

string $name — Extension name

[ Top ]

cCodeFooter [line 228]

string cCodeFooter(
string
$name)

Generate C code footer block for all elements of this class

Return: C code
Access: public

Parameters:

string $name — Extension name

[ Top ]

cCodeHeader [line 216]

string cCodeHeader(
string
$name)

Generate C code header block for all elements of this class

Return: C code
Access: public

Parameters:

string $name — Extension name

[ Top ]

docEntry [line 252]

string docEntry(
string
$extension)

Generate documentation code for element

Return: documentation content
Access: public

Parameters:

string $extension — id basename for extension

[ Top ]

docFooter [line 276]

string docFooter(
string
$name)

Generate documentation footer block for all elements of this class

Return: documentation fragment
Access: public

Parameters:

string $name — Extension name

[ Top ]

docHeader [line 264]

string docHeader(
string
$name)

Generate documentation header block for all elements of this class

Return: documentation fragment
Access: public

Parameters:

string $name — Extension name

[ Top ]

getIfCondition [line 132]

string getIfCondition(
)

ifCondition getter

[ Top ]

getName [line 61]

string getName(
)

Name getter

Return: function name

Overridden in child classes as:

CodeGen_Dependency_Lib::getName(): basename getter

CodeGen_Dependency_Header::getName(): name getter

[ Top ]

hCode [line 240]

string hCode(
class
$extension)

Generate C include file definitions for element

Return: C header code
Access: public

Overridden in child classes as:

CodeGen_Dependency_Header::hCode(): return header file code snippet

Parameters:

class $extension — Extension extension we are owned by

[ Top ]

ifConditionEnd [line 156]

string ifConditionEnd(
)

Conditional compilation end

[ Top ]

ifConditionStart [line 142]

string ifConditionStart(
)

Conditional compilation start

[ Top ]

isKeyword [line 174]

bool isKeyword(
string
$name)

Checks whether a string is a reserved name

Return: true if reserved
Access: public

Parameters:

string $name — name

[ Top ]

isName [line 188]

bool isName(
string
$name)

Checks whether a string is a valid C name

Return: true for valid names, false otherwise
Access: public

Parameters:

string $name — The name to check

[ Top ]

setDescription [line 102]

bool setDescription(
string
$text)

Description setter

Return: success status

Parameters:

string $text — function description

[ Top ]

setIfCondition [line 122]

void setIfCondition(
string
$code)

ifCondition setter

Parameters:

string $code — preprocessor #if condition

[ Top ]

setName [line 48]

bool setName(
string
$name)

Name setter

Return: success status

Parameters:

string $name — function name

[ Top ]

setSummary [line 80]

bool setSummary(
string
$text)

Summary setter

Return: success status

Parameters:

string $text — function summary

[ Top ]