Constants

This module contains all the constants used in the package, as well as the macro that they were created by.

COMMENTS_ARGUMENT = "the comments vector"

A documentation constant for the comments argument.

CONCATENATE_BOTH_KEYWORD = "if `true`, concatenate the highlights (only for PDFs)"

A documentation constant for the concatenate keyword (for the Both module).

CONCATENATE_KEYWORD = "if `true`, concatenate the highlights"

A documentation constant for the concatenate keyword.

CSV_ARGUMENT = "absolute or relative path to the CSV file"

A documentation constant for the csv argument.

DIRECTORY_DOES_NOT_EXIST_EXCEPTION = "the specified directory doesn't exist"

A documentation constant for the DirectoryDoesNotExist exception.

DIR_ARGUMENT = "a directory with PDF files"

A documentation constant for the dir argument.

DOES_NOT_EXIST_EXCEPTION = "the specified file or directory doesn't exist"

A documentation constant for the DoesNotExist exception.

FILE_DOES_NOT_EXIST_EXCEPTION = "the specified file doesn't exist"

A documentation constant for the FileDoesNotExist exception.

HEADER = "Highlight,Title,Author,Note,Location"

Default (expected) header for CSV files.

HIGHLIGHTS_ARGUMENT = "the highlights vector"

A documentation constant for the highlights argument.

INCORRECT_HEADER_EXCEPTION = "the specified file has an incorrect header"

A documentation constant for the IncorrectHeader exception.

INTEGRITY_CHECK_FAILED_EXCEPTION = "another exception was thrown while checking the integrity of the table"

A documentation constant for the IntegrityCheckFailed exception.

LAST_ELEMENT_IS_NOT_AN_INTEGER_EXCEPTION = "the last element in the line is not an integer"

A documentation constant for the LastElementIsNotAnInteger exception.

NOT_CSV_EXCEPTION = "the specified path does not end in `.csv`"

A documentation constant for the NotCSV exception.

NOT_CSV_OR_DIR_EXCEPTION = "the specified path does not end in `.csv` and is not a directory"

A documentation constant for the NotCSVorDir exception.

NOT_CSV_OR_PDF_OR_DIR_EXCEPTION = "the specified path does not end in `.csv` or `.pdf` and is not a directory"

A documentation constant for the NotCSVorPDForDir exception.

NOT_FIVE_COLUMNS_EXCEPTION = "the row does not represent elements for 5 columns"

A documentation constant for the NotFiveColumns exception.

NOT_PDF_EXCEPTION = "the specified path does not end in `.pdf`"

A documentation constant for the NotPDF exception.

PAGES_ARGUMENT = "the pages vector"

A documentation constant for the pages argument.

PDF_ARGUMENT = "absolute or relative path to the PDF file"

A documentation constant for the pdf argument.

TARGET_CSV_ARGUMENT = "a CSV file or a directory with PDF files"

A documentation constant for the target argument that mentions CSV.

TARGET_PDF_ARGUMENT = "a PDF file or a directory with PDF files"

A documentation constant for the target argument that mentions PDF.

@constant(name::Symbol, docstring::String, value::Union{Expr, String}) -> Expr

Create a constant with a documentation string and export it.

Arguments

• name::Symbol: name of the constant
• docstring::String: documentation string
• value::Union{Expr, String}: value of the constant

Returns

• Expr: constant definition

Example

using PDFHighlights
using Suppressor
using SyntaxTree

name = :CONSTANT_NAME
docstring = "Docstring"
value = "Value"

d1 = @capture_out @macroexpand(
    PDFHighlights.Internal.Constants.@constant(
        CONSTANT_NAME,
        "Docstring",
        "Value"
    )
) |> linefilter! |> dump

macro oof()
    return esc(
        quote
            @doc $(docstring)
            const $(name) = $(value)
            export $(name)
        end
    )
end

d2 = @capture_out @macroexpand(@oof) |> linefilter! |> dump

d1 == d2