AutoDoc.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX INC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX INC.
******************************************************************************/
#ifndef AUTO_DOC_H
#define AUTO_DOC_H
 
#include <vector>
#include <string>
#include <stdio.h>
 
// Return codes for success/failure
#define AUTODOC_SUCCESS 0
#define AUTODOC_FAILURE 1
 
namespace warptwin {
 
    // String constants for asciidoc
    const std::string TITLE = "= ";
 
    const std::string AUTHOR_EMAIL_START = " <";
    const std::string AUTHOR_EMAIL_END = "> ";
 
    const std::string HEADER_ONE = "== ";
 
    const std::string HEADER_TWO = "=== ";
 
    const std::string CODE_LITERAL = "```";
 
    const std::string TABLE_HEADER_START = "[\%header,cols=";
    const std::string TABLE_HEADER_END = "*]\n";
    const std::string TABLE_MARKER = "|===\n";
    const std::string TABLE_LINE_START = "|";
 
    const std::string IMAGE_START = "image::";
    const std::string ALIAS_START = "[";
    const std::string ALIAS_END = "]";
 
    const std::string LINK_START = "link:++";
    const std::string LINK_END = "++";
 
    const std::string DOC_REF_START = "xref:";

    class AutoDoc {
    public:
        AutoDoc(unsigned int string_alloc=4096);

        ~AutoDoc() {closeFile();}

        int file(const std::string &filename);
        std::string file() {return _filename;}

        int title(const std::string &str);

        int author(const std::string &name, const std::string &email="");

        int addPrimaryHeader(const std::string &str);

        int addSecondaryHeader(const std::string &str);

        int addText(const std::string &str);

        int addImage(const std::string &file, const std::string &alias="");

        int addTable(const std::vector<std::vector<std::string>> &data,
                    const std::vector<std::string> &col_headers={},
                    const std::vector<std::string> &row_headers={},
                    bool write_method=true);
        int addTable(const std::vector<std::vector<long int>> &data,
                    const std::vector<std::string> &col_headers={},
                    const std::vector<std::string> &row_headers={},
                    bool write_method=true);
        int addTable(const std::vector<std::vector<double>> &data,
                    const std::vector<std::string> &col_headers={},
                    const std::vector<std::string> &row_headers={},
                    bool write_method=true);

        int addCodeBlock(const std::string &str);

        int addLink(const std::string &link, const std::string &alias="");

        int addDocReference(const std::string &name, const std::string &alias="");

        void closeFile();
    private:
        template <typename T>
        int _addTable(const std::vector<std::vector<T>> &data,
                    const std::vector<std::string> &col_headers,
                    const std::vector<std::string> &row_headers,
                    bool write_method);

        void _write(const std::string &str);

        void _write(long int val);

        void _write(double val);

        FILE* _fp = nullptr;

        std::string _filename;

        std::string _internal_str = "";
 
        // These lock variables indicate when a key parameter, like a file
        // or the title, have been locked and can no longer be written
        // (For things that can only be written in a particular location)
        bool _file_lock = false;
        bool _title_lock = false;
        bool _author_lock = false;
    };
 
}
 
#endif