PrintConstants

enum PrintConstants

An Enum namespace for constants that are used across different entities in the Clarity framework.

  • A Unicode string value that has zero length.

    Declaration

    Swift

    static let emptyString: String
  • A Unicode string value that is a single space separator.

    Declaration

    Swift

    static let singleSpace: String
  • A Unicode string value that is a double space separator.

    Declaration

    Swift

    static let doubleSpace: String
  • A Unicode string value that is a triple space separator.

    Declaration

    Swift

    static let tripleSpace: String
  • A Unicode string value that is a double quadruple separator.

    Declaration

    Swift

    static let quadrupleSpace: String
  • A Unicode string value that is an exclamation mark.

    This value is currently used as a symbol to represent all types of conditional else clauses and the catch block of do-catch statements in event message strings.

    A future version of Clarity will have an option to designate a single node number for both clauses of conditional if statements that contain else clauses. When the option is selected the symbol will appear adjacent to a node number to signify an else clause for that node.

    Declaration

    Swift

    static let failNodeSymbol: String
  • A Unicode string representing the label of an effect message.

    Declaration

    Swift

    static let effectLabel: String
  • A Unicode string representing the single value label of a value reporter message.

    Note

    Note A single space suffix is concatenated at the end of the label rather than allocated its own slot in the composite array. This is for array optimisation purposes as well as for code semantics: the space is part of a sentence rather than acting as a column separator.

    Declaration

    Swift

    static let valueReporterLabel: String
  • A Unicode string representing the plural values label of a value reporter message.

    Note

    Note A single space suffix is concatenated at the end of the label rather than allocated its own slot in the composite array. This is for array optimisation purposes as well as for code semantics: the space is part of a sentence rather than acting as a column separator.

    Declaration

    Swift

    static let valuesReporterLabel: String
  • A Unicode string representing the label of an error reporter message.

    Note

    Note A single space suffix is concatenated at the end of the label rather than allocated its own slot in the composite array. This is for array optimisation purposes as well as for code semantics: the space is part of a sentence rather than acting as a column separator.

    Declaration

    Swift

    static let errorReporterLabel: String
  • A Unicode string representing the singular linking verb label for a reporter message.

    Note

    Note A single space prefix is concatenated at the beginning of the label rather than allocated its own slot in the composite array. This is for array optimisation purposes as well as for code semantics: the space is part of a sentence rather than acting as a column separator.

    Declaration

    Swift

    static let isLabel: String
  • A Unicode string representing the plural linking verb label for a reporter message.

    Note

    Note A single space prefix is concatenated at the beginning of the label rather than allocated its own slot in the composite array. This is for array optimisation purposes as well as for code semantics: the space is part of a sentence rather than acting as a column separator.

    Declaration

    Swift

    static let areLabel: String
  • A Unicode string representing a linker symbol between the message node ‘SKU style’ information section of an event message and its description readout.

    Note

    Note A double space prefix is concatenated at the beginning of the label and a single space suffix is concatenated at the end of the label. These spaces act as column separators but are not allocated slots in the composite array for optimisation purposes. They are also part of a section that would lose efficacy as a linker if spaced further apart: there are no custom spacers in these positions for this reason.

    Declaration

    Swift

    static let linker_EventDescription: String
  • A Unicode string representing a linker symbol between a control flow node symbol and a node number of event and reporter messages.

    Declaration

    Swift

    static let linker_NodeNumber: String
  • A Unicode string representing a general column spacer between function numbers and the node symbol section of control flow messages.

    Declaration

    Swift

    static let spacer_G1: String
  • A Unicode string representing a spacer that enables the fail node symbol to appear in the slot that is directly before other components of the node symbol section.

    Note

    Note If a message contains the fail node symbol the spacer is placed in the composite slot index index_FailNodeSymbolSpacer. If a message does not contain the fail node symbol the spacer is placed in both the fail node symbol slot index_FailNodeSymbol and the dedicated slot for the spacer index_FailNodeSymbolSpacer.

    The spacer length is calculated from the fail node symbol character count so the two slots will always be the same length.

    This arrangement maintains a left alignment of the other components of the node symbol section in one column.

    Important

    Important If the fail node symbol is ever made user customisable or changed to an Apple symbol the spacer length would need to be calculated using the method symbolSpaceCount().

    Declaration

    Swift

    static let spacer_FailNodeSymbol: String
  • A Unicode string representing a column spacer between the print number sometimes displayed when relative node numbering is used and the outcome symbol of an event message.

    Declaration

    Swift

    static let spacer_PostAbsoluteNodeNumber: String
  • A Unicode string representing a column spacer between the entity code and the function symbol section of a function name message.

    Declaration

    Swift

    static let spacer_F1: String
  • A Unicode string representing a column spacer between the function number and function name for a function name message.

    Declaration

    Swift

    static let spacer_F2: String
  • A Unicode string representing a spacer that compensates for the function type symbol when calculating right justification between the entity code and the raw value of FunctionType for control flow messages.

    Important

    Important If the raw value of FunctionType is ever made user customisable or changed to an Apple symbol the spacer length would need to be calculated using the method symbolSpaceCount().

    Note

    Note FunctionType should not be confused with FunctionTypeSymbols that are user customisable.

    Declaration

    Swift

    static let spacer_FType: String
  • An IndexSet containing the indexes of custom editable spacers within the message string composite array.

    Declaration

    Swift

    static let customSpacerIndexes: IndexSet
  • An IndexSet containing the indexes of default message components within the message string composite array.

    Declaration

    Swift

    static var defaultMessageIndexes: IndexSet
  • An IndexSet containing the indexes of print number (absolute node number) message components within the message string composite array.

    Declaration

    Swift

    static let absoluteNodeIndexes: IndexSet
  • An IndexSet containing the indexes of value reporter message components within the message string composite array.

    Declaration

    Swift

    static let valueReportIndexes: IndexSet
  • An IndexSet containing the indexes of reporter message components within the message string composite array.

    This IndexSet is used to build a message for print statements that have an associated value reporter node type but have no value argument supplied.

    The difference between a reporter and a value reporter message is that it simply omits the value labels.

    Declaration

    Swift

    static let reporterIndexes: IndexSet
  • An IndexSet containing the indexes of function name message components within the message string composite array.

    Declaration

    Swift

    static let functionNameIndexes: IndexSet
  • An IndexSet containing the indexes of effect message components within the message string composite array.

    Declaration

    Swift

    static let effectIndexes: IndexSet
  • An IndexSet containing the indexes of node only message components within the message string composite array.

    Declaration

    Swift

    static let nodeOnlyIndexes: IndexSet
  • An IndexSet containing the indexes of readout spacer section spacers within the message string composite array.

    This IndexSet is used for the calculation of the readout spacer section of event and value messages.

    Declaration

    Swift

    static let defaultReadoutSpacers: IndexSet
  • An IndexSet containing the indexes of readout spacer section components within the message string composite array.

    This IndexSet is used for the calculation of the readout spacer section of event and value messages.

    Note

    Note Readout spacer section compensation for the function type symbol is calculated into the value at index_RJustifyAdjusterFromFunctionElements and is therefore accounted for by defaultReadoutSpacers.

    Declaration

    Swift

    static let defaultReadoutComponents: IndexSet
  • An IndexSet containing the indexes of readout spacer section user settable components within the message string composite array.

    This IndexSet is used for the calculation of the readout spacer section of event and value messages.

    Declaration

    Swift

    static let userSettableSymbolReadoutComponents: IndexSet
  • An Int representing the slot position index of the first custom spacer within the message string composite array.

    Declaration

    Swift

    static let index_C1: Int
  • An Int representing the slot position index of a message entity code within the message string composite array.

    Declaration

    Swift

    static let index_EntityCode: Int
  • An Int representing the slot position index of a message maximum entity code length deviation spacer within the message string composite array.

    Declaration

    Swift

    static let index_EntityCodeDifferential: Int
  • An Int representing the slot position index of a message function symbol elements right justification spacer within the message string composite array.

    Declaration

    Swift

    static let index_RJustifyAdjusterFromFunctionElements: Int
  • An Int representing the slot position index of a message first function name section spacer within the message string composite array.

    Declaration

    Swift

    static let index_F1: Int
  • An Int representing the slot position index of a message function type symbol within the message string composite array.

    Declaration

    Swift

    static let index_FunctionTypeSymbol: Int
  • An Int representing the slot position index of the message function type raw value character within the message string composite array.

    Declaration

    Swift

    static let index_FunctionTypeString: Int
  • An Int representing the slot position index of a message function number inverse adjustment spacer within the message string composite array.

    Declaration

    Swift

    static let index_AdjustmentForFunctionNumberPlaces: Int
  • An Int representing the slot position index of the second custom spacer within the message string composite array.

    Declaration

    Swift

    static let index_C2: Int
  • An Int representing the slot position index of a message function number within the message string composite array.

    Declaration

    Swift

    static let index_UsedFunctionNumber: Int
  • An Int representing the slot position index of a general column spacer for control flow messages within the message string composite array.

    Declaration

    Swift

    static let index_G1: Int
  • An Int representing the slot position index of a message second function name section spacer within the message string composite array.

    Declaration

    Swift

    static let index_F2: Int
  • An Int representing the slot position index of the third custom spacer within the message string composite array.

    Declaration

    Swift

    static let index_C3: Int
  • An Int representing the slot position index of a message fail node symbol within the message string composite array.

    Declaration

    Swift

    static let index_FailNodeSymbol: Int
  • An Int representing the slot position index of a message fail node symbol spacer within the message string composite array.

    Declaration

    Swift

    static let index_FailNodeSymbolSpacer: Int
  • An Int representing the slot position index of a message control flow node symbol within the message string composite array.

    Declaration

    Swift

    static let index_ControlFlowNodeTypeSymbol: Int
  • An Int representing the slot position index of a message node symbol to node number linker within the message string composite array.

    Declaration

    Swift

    static let index_Linker_NodeNumber: Int
  • An Int representing the slot position index of a message function name within the message string composite array.

    Declaration

    Swift

    static let index_FunctionName: Int
  • An Int representing the slot position index of a message node number within the message string composite array.

    Declaration

    Swift

    static let index_UsedNodeNumber: Int
  • An Int representing the slot position index of a message node number left justification spacer within the message string composite array.

    Declaration

    Swift

    static let index_LJustifyAdjusterFromUsedNodeNumberPlaces: Int
  • An Int representing the slot position index of a message print number left justification spacer within the message string composite array.

    Declaration

    Swift

    static let index_LJustifyAdjusterFromAbsoluteNodeNumberPlaces: Int
  • An Int representing the slot position index of a message print number within the message string composite array.

    Declaration

    Swift

    static let index_AbsoluteNodeNumber: Int
  • An Int representing the slot position index of the spacer following the message print number within the message string composite array.

    Declaration

    Swift

    static let index_PostAbsoluteNodeNumber: Int
  • An Int representing the slot position index of the fourth custom spacer within the message string composite array.

    Declaration

    Swift

    static let index_C4: Int
  • An Int representing the slot position index of a message outcome symbol within the message string composite array.

    Declaration

    Swift

    static let index_OutcomeSymbol: Int
  • An Int representing the slot position index of a message SKU section to description linker within the message string composite array.

    Declaration

    Swift

    static let index_Linker_EventDescription: Int
  • An Int representing the slot position index of a value reporter message values label within the message string composite array.

    Declaration

    Swift

    static let index_ReporterValuesLabel: Int
  • An Int representing the slot position index of an event message description within the message string composite array.

    Declaration

    Swift

    static let index_EventDescription: Int
  • An Int representing the slot position index of a value reporter message linking verb label within the message string composite array.

    Declaration

    Swift

    static let index_ReporterAuxiliaryLabel: Int
  • An Int representing the slot position index of an effect message label within the message string composite array.

    Declaration

    Swift

    static let index_EffectLabel: Int
  • An Int representing the slot position index of an effect message description within the message string composite array.

    Declaration

    Swift

    static let index_EffectDescription: Int