[ 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_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
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_Extension

Source Location: /CodeGen-1.0.1/CodeGen/Extension.php

Class Overview

Extension generator class

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 47]
Extension generator class

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

$acfragments = array("top"=>array(),"bottom"=>array())

[line 215]

acinclude fragments

Access: protected

Type: array

[ Top ]

$authors = array()

[line 124]

The authors contributing to this extension

Access: protected

Type: array

[ Top ]

$changelog = ""

[line 141]

Release changelog

Access: protected

Type: string

[ Top ]

$code = array()

[line 174]

Code snippets

Access: protected

Type: array

[ Top ]

$codegen =

[line 223]

CodeGen_Tool_Code instance for internal use

Access: public

Type: object

[ Top ]

$configfragments = array("top"=>array(),"bottom"=>array())

[line 206]

config.m4 fragments

Access: protected

Type: array

[ Top ]

$description =

[line 84]

extension description

Access: protected

Type: string

[ Top ]

$dirpath = "."

[line 150]

Basedir for all created files

Access: public

Type: string

[ Top ]

$headers = array()

[line 167]

External header files

Access: protected

Type: array

[ Top ]

$language = "c"

[line 107]

The implementation language

Currently we support "c" and "cpp"

Access: protected

Type: string

[ Top ]

$libs = array()

[line 159]

External libraries

Access: protected

Type: array

[ Top ]

$license = NULL

[line 91]

The license for this extension

Access: protected

Type: object

[ Top ]

$makefragments = array()

[line 197]

Makefile fragments

Access: protected

Type: array

[ Top ]

$name = "unknown"

[line 68]

The extensions basename (C naming rules apply)

Access: protected

Type: string

[ Top ]

$packageFiles = array()

[line 181]

The package files created by this extension

Access: protected

Type: array

[ Top ]

$platform = null

[line 116]

The target platform for this extension

Possible values are "unix", "win" and "all"

Access: protected

Type: string

[ Top ]

$prefix = ""

[line 132]

Name prefix for functions etc.

Access: protected

Type: string

[ Top ]

$release = NULL

[line 98]

The release info for this extension

Access: protected

Type: object

[ Top ]

$summary = "The unknown extension"

[line 76]

The extensions descriptive name

Access: protected

Type: string

[ Top ]

$version = ""

[line 188]

Version requested by input if any

Access: protected

Type: string

[ Top ]

Method Detail

__construct (Constructor) [line 232]

CodeGen_Extension __construct(
)

The constructor

Access: public

[ Top ]

addAcIncludeFragment [line 675]

void addAcIncludeFragment(
string
$text, [
$position = "top"])

Add acinclude.m4 fragment

Access: public

Parameters:

string $text —

$position —

[ Top ]

addAuthor [line 380]

void addAuthor(
object a
$author)

Add an author or maintainer to the extension

Access: public

Parameters:

object a $author — maintainer object

[ Top ]

addCode [line 453]

void addCode(
string
$role, string
$position, string
$code)

Add verbatim code snippet to extension

Access: public

Parameters:

string $role — which file to put the code to

string $position — where in the file the code should be put

string $code — the actual code

[ Top ]

addConfigFragment [line 659]

void addConfigFragment(
string
$text, [
$position = "top"])

Add config.m4 fragment

Access: public

Parameters:

string $text —

$position —

[ Top ]

addHeader [line 488]

void addHeader(
CodeGen_Dependency_Header
$header)

Add toplevel header file dependancy

Var: header filename

Parameters:

CodeGen_Dependency_Header $header —

[ Top ]

addLib [line 470]

void addLib(
CodeGen_Dependency_Lib
$lib)

Add toplevel library dependancy

Var: library basename

Parameters:

CodeGen_Dependency_Lib $lib —

[ Top ]

addMakeFragment [line 646]

void addMakeFragment(
string
$text)

Add makefile fragment

Access: public

Parameters:

string $text —

[ Top ]

addPackageFile [line 569]

bool addPackageFile(
string
$type, string
$path, [string
$dir = ""])

Add a package file by type and path

Return: success state
Access: public

Parameters:

string $type — type

string $path — path

string $dir — optional target dir

[ Top ]

addSourceFile [line 594]

void addSourceFile(
string
$name, [string
$dir = ""])

Add a source file to be copied to the extension dir

Access: public

Parameters:

string $name — path

string $dir — optional target dir

[ Top ]

cCodeEditorSettings [line 762]

string cCodeEditorSettings(
)

Generate Editor settings block for C source files

Return: Editor settings comment block
Access: public

[ Top ]

copyright [line 61]

string copyright(
)

Copyright message

Abstract:
Access: public

[ Top ]

docEditorSettings [line 783]

string docEditorSettings(
[int
$level = 3])

Generate Editor settings block for documentation files

Return: Editor settings comment block
Access: public

Parameters:

int $level — Directory nesting depth of target file (default: 3)

[ Top ]

getChangelog [line 267]

string getChangelog(
)

changelog getter

Access: public

[ Top ]

getLanguage [line 353]

string getLanguage(
)

Get programming language

[ Top ]

getName [line 293]

string getName(
)

Get extension base name

[ Top ]

getPrefix [line 440]

string getPrefix(
)

Get extension name prefix

[ Top ]

getVersion [line 523]

string getVersion(
)

Get requested version

[ Top ]

haveVersion [line 553]

bool haveVersion(
string
$version)

Check requested version

Parameters:

string $version — version

[ Top ]

setChangelog [line 254]

bool setChangelog(
string
$changelog)

Set method for changelog

Return: true on success
Access: public

Parameters:

string $changelog — changelog

[ Top ]

setDescription [line 316]

void setDescription(
string
$text)

Set extension documentation text

Access: public

Parameters:

string $text — long description

[ Top ]

setLanguage [line 328]

void setLanguage(
string
$lang)

Set the programming language to produce code for

Access: public

Parameters:

string $lang — programming language name

[ Top ]

setLicense [line 411]

void setLicense(
object
$license)

Set license

Access: public

Parameters:

object $license —

[ Top ]

setName [line 278]

void setName(
string
$name)

Set extension base name

Access: public

Parameters:

string $name — name

[ Top ]

setPlatform [line 364]

void setPlatform(
string
$type)

Set target platform for generated code

Access: public

Parameters:

string $type — platform name

[ Top ]

setPrefix [line 425]

void setPrefix(
string
$prefix)

Set extension name prefix (for functions etc.)

Access: public

Parameters:

string $prefix — name

[ Top ]

setRelease [line 397]

void setRelease(
$release)

Set release info

Access: public

Parameters:

$release —

[ Top ]

setSummary [line 304]

void setSummary(
string
$text)

Set extension summary text

Access: public

Parameters:

string $text — short summary

[ Top ]

setVersion [line 533]

void setVersion(
string
$version)

Set requested version

Parameters:

string $version —

[ Top ]

version [line 54]

string version(
)

Current version number

Abstract:
Access: public

[ Top ]

writeDotCvsignore [line 691]

void writeDotCvsignore(
string
0)

Write .cvsignore entries

Access: public

Parameters:

string 0 — directory to write to

[ Top ]