Text.PCLT.Template

Contents

Template pieces
Parsing from a lazy ByteString to a localized template content
Localized template
Text.PCLT.Config.pcsStrictOrient_ofParamsAndCmpsts_onDfltLngTplsSets
Requirement for making a representation from template - SDL
Localizable template

Description

Here are declared LocalizableTemplate (also called PCLT) and LocalizedTemplate. Here by localization is meant localization in languages. First (localizable template) is above languages, while second (localized template) is a template version in a concrete language.

Synopsis

Template pieces

data PCS_SpecificMarkings Source

These are types of template pieces. They are made by ssm2ldtm from SeparatedSectorMarker

Constructors

PlainText_LngTplM
Parameter_LngTplM
Composite_LngTplM
Unsupported_LngTplM SeparatedSectorMarker

Instances

Eq PCS_SpecificMarkings
Show PCS_SpecificMarkings
Typeable PCS_SpecificMarkings
HasStaticRawPCLTs PCS_SpecificMarkings
ShowAsPCSI PCS_SpecificMarkings

ssm2ldtm :: SeparatedSectorMarker -> PCS_SpecificMarkings Source

type LngTpl_AbstractedString = [(PCS_SpecificMarkings, ByteString, MarkedChunkLength)]Source

Template content.

listOfParams :: LngTpl_AbstractedString -> [ParamName_LBS]Source

Extract a list of parameter names from a template content.

Parsing from a lazy ByteString to a localized template content

type ParserBadResult = String Source

data PCLT_ParserLowLevelFailure Source

These errors are possible only if program is wrong.

Constructors

UnexpectedParserResult_PLLF_PCLT ParserBadResult
BadMarker_PLLF_PCLT SeparatedSectorMarker ByteString ChunkIndexInList_

Instances

Show PCLT_ParserLowLevelFailure
Typeable PCLT_ParserLowLevelFailure
HasStaticRawPCLTs PCLT_ParserLowLevelFailure
ShowAsPCSI PCLT_ParserLowLevelFailure

doTheParse :: PCLT_InnerConfig -> ByteString -> ([PCLT_ParserLowLevelFailure], Maybe (LngTpl_AbstractedString, [PCLT_CompositeKey]))Source

The parsing uses parameters Test.PCLT.Config.pcsParameterPlaceholderWrapper and Test.PCLT.Config.pcsCompositePlaceholderWrapper of Test.PCLT.Config.PCLT_InnerConfig. The list [PCLT_CompositeKey] in the result is a list of composite keys (template IDs, used by template as inclusions)

Localized template

type PCLT_CatalogMap = Map PCLT_ID LocalizableTemplate Source

type LngTpl_SubCompositesMap = PCLT_CatalogMap Source

data LocalizedTemplate Source

Constructors

LocalizedTemplate

Fields

ldtAbstractedString :: LngTpl_AbstractedString

ldtSubcompositesMap :: LngTpl_SubCompositesMap

Each composition tree is kept together with each localization. This is done for speedup and is a source of complexities, when forming a catalog and sustaining it's data consistency. So it comes to this: templates are purely-referenced by

catalog (PCLT_CatalogMap) and
templates, that uses them as composites (LngTpl_SubCompositesMap).

By "purely-reference" here is meant, that templates are formed only once, they have one instace in memory, but are referenced twice - from composeds and from catalog map

Instances

Show LocalizedTemplate
Typeable LocalizedTemplate

Text.PCLT.Config.pcsStrictOrient_ofParamsAndCmpsts_onDfltLngTplsSets

type DefaultLngTpl = LocalizedTemplate Source

type NondefaultLngTpl = LocalizedTemplate Source

compareStrictOrientationOnDefault :: PCLT_ID -> StrictOrient_ofParamsAndCmpsts_onDfltLngTplsSets -> NondefaultLngTpl -> DefaultLngTpl -> Bool Source

Carrying strict orientation routines. See description of StrictOrient_ofParamsAndCmpsts_onDfltLngTplsSets.

_compareStrictOrientationOnDefault :: PCLT_ID -> StrictOrient_ofParamsAndCmpsts_onDfltLngTplsSets -> ([PCLT_ID], [ParamName_LBS]) -> ([PCLT_ID], [ParamName_LBS]) -> Bool Source

Requirement for making a representation from template - SDL

data PCLT_ShowDetalizationLevel Source

This is an extending wrapper around SDL. It is used for specification of requirement for making representation from template. This specification is attached to every localizable template in PCLT catalog

Constructors

PCLT_SDL ShowDetalizationLevel	Plain SDL, nominal. If SDL of representation reciever is less then that, then template cann't be used in representation generation.
PCLT_SDL_ToTemplateLink PCLT_ID	"The requirement is the same as is specified for referenced template".
PCLT_SDL_ToParamCompositeLink PCLT_ParamKey	"The requirement is the same as is specified a for referenced template, which is referenced by a `PCSI_PV` value of referenced parameter (of current template)".
PCLT_SDL_Errornous PCLT_ErrornousSDL	In input data for catalog formation the given specification is errornous. If config's (Text.PCLT.Config) parameters `pcsAllowEmptySDL_parseItByModusMargin` and/or `pcsAllowUnreadableSDL_parseIdByModusMargin` are positive, then instead of `PCLT_SDL_Errornous` the parser (`str2PCLT_SDL`) will use `marginOfSDLModus` to set valid specification. When representation generator meets `PCLT_SDL_Errornous` it won't use template, and return an error.

Instances

Eq PCLT_ShowDetalizationLevel
Show PCLT_ShowDetalizationLevel
Typeable PCLT_ShowDetalizationLevel
HasStaticRawPCLTs PCLT_ShowDetalizationLevel
ShowAsPCSI PCLT_ShowDetalizationLevel

type PCLT_RequiredShowDetalizationLevel = PCLT_ShowDetalizationLevel Source

type PCLT_AllocatedShowDetalizationLevel = PCLT_ShowDetalizationLevel Source

data PCLT_RawCatalogData Source

Raw templates (both localizeds, and localizables). Input data for catalog formation. Used by HasStaticRawPCLTs class (declared in Text.PCLT.HasStaticRawPCLTs)

Constructors

PCLT_RawCatalogData (Map PCLT_ID (Map LanguageName ByteString, PCLT_RequiredShowDetalizationLevel))

Instances

Show PCLT_RawCatalogData
Typeable PCLT_RawCatalogData

data PCLT_ErrornousSDL Source

This is a bad result of parsing some String into PCLT_ShowDetalizationLevel. The second argument is this bad input.

Constructors

UnreadableSDL_ESDL SDLModus String

Instances

Eq PCLT_ErrornousSDL
Show PCLT_ErrornousSDL
Typeable PCLT_ErrornousSDL
HasStaticRawPCLTs PCLT_ErrornousSDL
ShowAsPCSI PCLT_ErrornousSDL

__const_esdl_rawinputshowsize_inShowAsPCSI :: Int Source

A constant currently set to 25. It is used in a parser str2PCLT_SDL: if the input is errornous, this much symbols of input are saved in UnreadableSDL_ESDL. If input is bigger, then the saved trunc is tailed with "..."

str2PCLT_SDL :: SDLModus -> String -> PCLT_InnerConfig -> PCLT_ShowDetalizationLevel Source

Parse String into PCLT_ShowDetalizationLevel. First of all parser tries strict_str2sdl. Then, if failed, parser uses following config entries:

pcsParameterPlaceholderWrapper - if prefix and postfix of input is this (by default it is "@@|"), then it is parsed into PCLT_SDL_ToParamCompositeLink
pcsCompositePlaceholderWrapper - if prefix and postfix of input is this (by default it is "##|"), then it is parsed into PCLT_SDL_ToTemplateLink
pcsAllowEmptySDL_parseItByModusMargin - if it is positive and input is empty, then it gets parsed into (PCLT_SDL $ marginOfSDLModus modus), where modus is first argument; esle, if parameter is negative and input is empty, it is parsed to PCLT_SDL_Errornous
pcsAllowUnreadableSDL_parseIdByModusMargin - if it is positive and input is unparsable, then it gets parsed into PCLT_SDL $ marginOfSDLModus modus, where modus is first argument; esle, if parameter is negative and input is unparsable, it is parsed to PCLT_SDL_Errornous

Localizable template

data LocalizableTemplate Source

Constructors

LocalizableTemplate
Fields pcltLocalizationsMap :: Map LanguageName LocalizedTemplate pcltRequiredSDL :: PCLT_RequiredShowDetalizationLevel If SDL of representation reciever is less then that, then template cann't be used in representation generation.

Instances

Show LocalizableTemplate
Typeable LocalizableTemplate