language-puppet-0.1.5: Tools to parse and evaluate the Puppet DSL.

Safe HaskellSafe-Infered




type Catalog = [CResource]Source

This is the potentially unsolved list of resources in the catalog.

data LinkType Source

Relationship link type.

data ResolvedValue Source

The list of resolved values that are used to define everything in a FinalCatalog and in the resolved parts of a Catalog. They are to be compared with the Values.

type GeneralValue = Either Expression ResolvedValueSource

This type holds a value that is either from the ASL or fully resolved.

type GeneralString = Either Expression StringSource

This type holds a value that is either from the ASL or a fully resolved String.

data CResource Source

This describes the resources before the final resolution. This is required as they must somehow be collected while the Statements are interpreted, but the necessary Expressions are not yet available. This is because in Puppet the Statement order should not alter the catalog's content.

The relations are not stored here, as they are pushed into a separate internal data structure by the interpreter.




crid :: Int

Resource ID, used in the Puppet YAML.

crname :: GeneralString

Resource name.

crtype :: String

Resource type.

crparams :: [(GeneralString, GeneralValue)]

Resource parameters.

crvirtuality :: Virtuality

Resource virtuality.

pos :: SourcePos

Source code position of the resource definition.


type ResIdentifier = (String, String)Source

Resource identifier, made of a type, name pair.

type Relation = (LinkType, ResIdentifier)Source

Resource relation, made of a LinkType, ResIdentifier pair.

data RResource Source

This is a fully resolved resource that will be used in the FinalCatalog.




rrid :: !Int

Resource ID.

rrname :: !String

Resource name.

rrtype :: !String

Resource type.

rrparams :: !(Map String ResolvedValue)

Resource parameters.

rrelations :: ![Relation]

Resource relations.

rrpos :: !SourcePos

Source code position of the resource definition.

data RelUpdateType Source

Type of update/override, so they can be applied in the correct order. This part is probably not behaving like vanilla puppet, as it turns out this are many fairly acceptable behaviours and the correct one is not documented.



data ScopeState Source

The most important data structure for the interpreter. It stores its internal state.




curScope :: ![[ScopeName]]

The list of scopes. It works like a stack, and its initial value must be [["::"]]. It is a stack of lists of strings. These lists can be one element wide (usual case), or two elements (inheritance), so that variables could be assigned to both scopes.

curVariables :: !(Map String (GeneralValue, SourcePos))

The list of known variables. It should be noted that the interpreter tries to resolve them as soon as it can, so that it can store their current scope.

curClasses :: !(Map String SourcePos)

The list of classes that have already been included, along with the place where this happened.

curDefaults :: ![ResDefaults]

List of defaults to apply. All defaults are applied at the end of the interpretation of each top level statement.

curResId :: !Int

Stores the value of the current crid.

curPos :: !SourcePos

Current position of the evaluated statement. This is mostly used to give useful error messages.

nestedtoplevels :: !(Map (TopLevelType, String) Statement)

List of "top levels" that have been parsed inside another top level. Their behaviour is curently non canonical as the scoping rules are unclear.

getStatementsFunction :: TopLevelType -> String -> IO (Either String Statement)

This is a function that, given the type of a top level statement and its name, should return it.

getWarnings :: ![String]

List of warnings.

curCollect :: ![CResource -> CatalogMonad Bool]

A bit complicated, this stores the collection functions. These are functions that determine whether a resource should be collected or not.

unresolvedRels :: ![([(LinkType, GeneralValue, GeneralValue)], (String, GeneralString), RelUpdateType, SourcePos)]

This stores unresolved relationships, because the original string name can't be resolved. Fieds are [ ( [dstrelations], srcresource, type, pos ) ]

computeTemplateFunction :: String -> String -> [(String, GeneralValue)] -> IO (Either String String)

Function that takes a filename, the current scope and a list of variables. It returns an error or the computed template.

type CatalogMonad = ErrorT String (StateT ScopeState IO)Source

The monad all the interpreter lives in. It is ErrorT with a state.