Copyright (C) 2000-2012 |
GNU Info (g77-300.info)Internal Naming ConventionsInternal Naming Conventions =========================== Names exported by FFE modules have the following (regular-expression) forms. Note that all names beginning `ffeMOD' or `FFEMOD', where MOD is lowercase or uppercase alphanumerics, respectively, are exported by the module `ffeMOD', with the source code doing the exporting in `MOD.h'. (Usually, the source code for the implementation is in `MOD.c'.) Identifiers that don't fit the following forms are not considered exported, even if they are according to the C language. (For example, they might be made available to other modules solely for use within expansions of exported macros, not for use within any source code in those other modules.) `ffeMOD' The single typedef exported by the module. `FFEUMOD_[A-Z][A-Z0-9_]*' (Where UMOD is the uppercase for of MOD.) A `#define' or `enum' constant of the type `ffeMOD'. `ffeMOD[A-Z][A-Z][a-z0-9]*' A typedef exported by the module. The portion of the identifier after `ffeMOD' is referred to as `ctype', a capitalized (mixed-case) form of `type'. `FFEUMOD_TYPE[A-Z][A-Z0-9_]*[A-Z0-9]?' (Where UMOD is the uppercase for of MOD.) A `#define' or `enum' constant of the type `ffeMODTYPE', where TYPE is the lowercase form of CTYPE in an exported typedef. `ffeMOD_VALUE' A function that does or returns something, as described by VALUE (see below). `ffeMOD_VALUE_INPUT' A function that does or returns something based primarily on the thing described by INPUT (see below). Below are names used for VALUE and INPUT, along with their definitions. `col' A column number within a line (first column is number 1). `file' An encapsulation of a file's name. `find' Looks up an instance of some type that matches specified criteria, and returns that, even if it has to create a new instance or crash trying to find it (as appropriate). `initialize' Initializes, usually a module. No type. `int' A generic integer of type `int'. `is' A generic integer that contains a true (non-zero) or false (zero) value. `len' A generic integer that contains the length of something. `line' A line number within a source file, or a global line number. `lookup' Looks up an instance of some type that matches specified criteria, and returns that, or returns nil. `name' A `text' that points to a name of something. `new' Makes a new instance of the indicated type. Might return an existing one if appropriate--if so, similar to `find' without crashing. `pt' Pointer to a particular character (line, column pairs) in the input file (source code being compiled). `run' Performs some herculean task. No type. `terminate' Terminates, usually a module. No type. `text' A `char *' that points to generic text. automatically generated by info2www version 1.2.2.9 |