ellipsis-environment.dirs File Reference

Predefined macros that are captured from the environment. More...

Macros
#define	__PROJECT__
	Define a project to which the compiled translation unit belongs.
#define	ELLIPSIS_CODE_LANGUAGE   {.C}
	The tokens to add to an code snippet in running text.
#define	ELLIPSIS_CODEBLOCK_LANGUAGE   {.C .numberLines}
	The tokens to add to a code block.
#define	ELLIPSIS_HASH_INCLUDE_DISABLE
	Disable hashing of the predefined files in the include directory.
#define	ELLIPSIS_LOOP_DEPTH   4
	The depth of the include processing for the loop feature.
#define	ELLIPSIS_MARK_LINE
	A hook to add code that puts line number information into the output stream.
#define	ELLIPSIS_MARK_LINE_RETURN
	A hook to add code that puts line number information when returning from header into the output stream.
#define	ELLIPSIS_MARK_LINE_START
	A hook to add code that puts line number information for a newly starting header into the output stream.
#define	ELLIPSIS_PREDEFINED
	Use this file name for the host specific predefined include paths and macros.

Detailed Description

Predefined macros that are captured from the environment.

See also

environment

Warning

The macros in this group may not be undefined or redefined

Macro Definition Documentation

__PROJECT__

#define __PROJECT__

Define a project to which the compiled translation unit belongs.

At the top of each translation unit you would then typically relate to that project name at the beginning by binding the __UNIT__ pseudo-macro. Examples:

#xbind __UNIT__ __PROJECT__

declares that the current translation unit is the top level unit for this project.

#xbind __SUBUNIT__(cruft)

declares that the current translation unit is the sub unit cruft, derived from the top level unit.

See also

Preprocessor state and identifier composition

__UNIT__

__SUBUNIT__

Warning

This macro may not be undefined or changed otherwise

Remarks

This is initialized from an environment variable, the indicated value is the default.

ELLIPSIS_CODE_LANGUAGE

#define ELLIPSIS_CODE_LANGUAGE   {.C}

The tokens to add to an code snippet in running text.

Currently this is only used in markdown to add additional information to an in-text construct such as "`__TIME__`". The default marks such snippets to be C.

Warning

This macro may not be undefined or changed otherwise

Remarks

This only adds such a contruct if there is none in the source.

This is initialized from an environment variable, the indicated value is the default.

ELLIPSIS_CODEBLOCK_LANGUAGE

#define ELLIPSIS_CODEBLOCK_LANGUAGE   {.C .numberLines}

The tokens to add to a code block.

Currently this is only used in markdown to add additional information to a codeblock marked with "```". The default marks such snippets to be C and adds line numbers.

Warning

This macro may not be undefined or changed otherwise

Remarks

This only adds such a contruct if there is none in the source.

This is initialized from an environment variable, the indicated value is the default.

ELLIPSIS_HASH_INCLUDE_DISABLE

#define ELLIPSIS_HASH_INCLUDE_DISABLE

Disable hashing of the predefined files in the include directory.

If this is not set, these files are hashed from information in the version that had bee available at compilation time of the ellipsis executable.

Remarks

Use this if you want to develop for eĿlipsis by modifying some of these files.

The goal of doing all this is to make the ellipsis executable relocatable.

Remarks

This is initialized from an environment variable, the indicated value is the default.

ELLIPSIS_LOOP_DEPTH

#define ELLIPSIS_LOOP_DEPTH   4

The depth of the include processing for the loop feature.

See also

ellipsis-loop.dirs

This is a configuration parameter for eĿlipsis that can be overwritten with an environment variable of the same name. Per default it is set to the maximum supported value 4.

Warning

This macro may not be undefined or changed otherwise

Remarks

This is initialized from an environment variable, the indicated value is the default.

ELLIPSIS_MARK_LINE

#define ELLIPSIS_MARK_LINE

A hook to add code that puts line number information into the output stream.

Warning

This macro may not be undefined or changed otherwise

Remarks

This is initialized from an environment variable, the indicated value is the default.

ELLIPSIS_MARK_LINE_RETURN

#define ELLIPSIS_MARK_LINE_RETURN

A hook to add code that puts line number information when returning from header into the output stream.

Warning

This macro may not be undefined or changed otherwise

Remarks

This is initialized from an environment variable, the indicated value is the default.

ELLIPSIS_MARK_LINE_START

#define ELLIPSIS_MARK_LINE_START

A hook to add code that puts line number information for a newly starting header into the output stream.

Warning

This macro may not be undefined or changed otherwise

Remarks

This is initialized from an environment variable, the indicated value is the default.

ELLIPSIS_PREDEFINED

#define ELLIPSIS_PREDEFINED

Use this file name for the host specific predefined include paths and macros.

If this is not set, this information is searched in the include/c directory among predefined configurations.

Remarks

This is used by ellipsis-gnuc.sh which indicates its findings here for subsequent compiler phases.

This is initialized from an environment variable, the indicated value is the default.