org.eigenbase.resgen

Class CppHeaderGenerator

java.lang.Object

org.eigenbase.resgen.CppHeaderGenerator

public class CppHeaderGenerator
extends Object

Generates a C++ header file containing resource definitions.

Author:

jhyde

Constructor Summary

Constructors

Constructor and Description
CppHeaderGenerator(File srcFile, File file, String className, String baseClassName, String defaultExceptionClassName) Creates a C++ header generator.

Method Summary

Modifier and Type	Method and Description
protected void	generateDoNotModifyHeader(PrintWriter pw)
protected void	generateGeneratedByBlock(PrintWriter pw)
void	generateModule(ResourceGen generator, ResourceDef.ResourceBundle resourceList, PrintWriter pw)
void	generateResource(ResourceDef.Resource resource, PrintWriter pw) Generates code for a particular resource.
protected String[]	getArgTypes(String message) Returns the number and types of parameters in the given error message, expressed as an array of Strings (legal values are currently "String", "Number", "java.util.Date", and null) ordered by parameter number.
protected String	getArgumentList(String message)
protected String	getBaseClassName() Returns the fully-qualified name of the base class.
protected String	getClassName() Returns the fully-qualified name of the class being generated, for example "happy.BirthdayResource_en_US".
protected File	getFile() Returns the generator's output file.
protected String	getParameterList(String message) Returns a parameter list string, e.g.
protected String	getSrcFileForComment() Returns the XML or .properties source file, in a manner suitable for use in source code comments.
void	setScmSafeComments(boolean enabled) Configures whether this generator will output comments that may be submitted to a source code management system.
protected boolean	useScmSafeComments()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CppHeaderGenerator

public CppHeaderGenerator(File srcFile,
                          File file,
                          String className,
                          String baseClassName,
                          String defaultExceptionClassName)

Creates a C++ header generator.

Parameters:

srcFile - Source file

file - File

className - Class name

baseClassName - Name of base class, must not be null, typically

defaultExceptionClassName - Default exception class name

Method Detail

generateModule

public void generateModule(ResourceGen generator,
                           ResourceDef.ResourceBundle resourceList,
                           PrintWriter pw)

getClassName

protected String getClassName()

Returns the fully-qualified name of the class being generated, for example "happy.BirthdayResource_en_US".

Returns:

Name of class

getBaseClassName

protected String getBaseClassName()

Returns the fully-qualified name of the base class.

Returns:

Name of base class

getArgTypes

protected String[] getArgTypes(String message)

Returns the number and types of parameters in the given error message, expressed as an array of Strings (legal values are currently "String", "Number", "java.util.Date", and null) ordered by parameter number.

Parameters:

message - Message

Returns:

Array of argument type names

generateResource

public void generateResource(ResourceDef.Resource resource,
                             PrintWriter pw)

Generates code for a particular resource.

Parameters:

resource - Resource

pw - Writer

setScmSafeComments

public void setScmSafeComments(boolean enabled)

Configures whether this generator will output comments that may be submitted to a source code management system. In general, it squelches comments indicating the file should not be checked in as well as comments change with each generation of the file (thereby avoiding merge conflicts).

Parameters:

enabled - Whether enabled

useScmSafeComments

protected boolean useScmSafeComments()

generateDoNotModifyHeader

protected void generateDoNotModifyHeader(PrintWriter pw)

generateGeneratedByBlock

protected void generateGeneratedByBlock(PrintWriter pw)

getFile

protected File getFile()

Returns the generator's output file. e.g., "BirthdayResource.java"

Returns:

Output file

getSrcFileForComment

protected String getSrcFileForComment()

Returns the XML or .properties source file, in a manner suitable for use in source code comments. Path information is stripped if SCM-safe comment style is enabled.

Returns:

source file

See Also:

setScmSafeComments(boolean)

getParameterList

protected String getParameterList(String message)

Returns a parameter list string, e.g. "String p0, int p1".

Parameters:

message - Message to parse

Returns:

Parameter list as a string

getArgumentList

protected String getArgumentList(String message)