🟠Types.hs

Module Documentation: Types

The Types module in Haskell defines the core data structures used for document handling within the application. This module centralizes the definitions of document components and links, facilitating a unified approach to document manipulation and formatting across other modules.

Data Types and Structures

Doc

• Purpose: Represents the structure of a document or any part of a document with various formatting attributes and content.

• Fields:

  • Formatting Flags: Boolean flags such as isBold, isUnderlined, isItalic to denote text styling.

  • Structural Flags: Flags like isTitle, isDate, isAuthor indicating the semantic roles of the document part.

  • Component Flags: Such as isDocument, isBody, isHeader, isSection, isParagraph, isCodeBlock, isList define the structure of the document.

  • Content: The string field contains actual text content.

  • Nested Structure: The list field allows nested Doc structures, enabling hierarchical document formats.

  • Links and Images: The link and image fields store URL strings, supporting hyperlinks and embedded images.

Link

• Type Definition: Alias for String to represent URL links more explicitly within the code.

• Usage: Used primarily for document elements that contain hyperlinks or refer to external resources.

Constants

defaultDoc

• Purpose: Provides a default, empty Doc structure with all boolean flags set to False and empty content fields. It serves as a baseline for creating new Doc instances or resetting existing ones.

• Fields: Initializes all fields of Doc to default values, typically False for Boolean flags and empty strings for String fields.

Conclusion

The Types module plays a foundational role in the application by defining key structures that standardize how documents and their components are represented and manipulated. This approach ensures consistency and reliability in document processing tasks across the application.

module Types(Doc(..), Link, defaultDoc) where

type Link = String

data Doc = Doc {
    isBold::Bool,
    isUnderlined::Bool,
    isItalic::Bool,
    isTitle::Bool,
    isDate::Bool,
    isAuthor::Bool,
    isCode::Bool,
    isString::Bool,
    string::String,

    isDocument::Bool,
    isBody::Bool,
    isHeader::Bool,
    isSection::Bool,
    isParagraph::Bool,
    isCodeBlock::Bool,
    isList::Bool,
    list::[Doc],

    isLink::Bool,
    link::Link,

    isImage::Bool,
    image::Link
} deriving (Show, Eq);

defaultDoc :: Doc
defaultDoc = Doc{isBold = False, isUnderlined = False, isItalic = False,
    isTitle = False, isCode = False, isImage = False, isAuthor = False,
    isBody = False, isCodeBlock = False, isLink = False, isList = False,
    isDate = False, isString = False, isHeader = False, isParagraph = False,
    isSection = False, isDocument = False, string = "", list = [], link = "",
    image = ""}