PropertyDefinitionDoxygenFormatter.cpp

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * @package    ArmarXCore::core
 * @author     Jan Issac (jan dot issac at gmx dot de)
 * @date       2012
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
 
#include "PropertyDefinitionDoxygenFormatter.h"
 
#include <SimoxUtility/algorithm/string/string_tools.h>
 
#include <sstream>
#include <iomanip>
 
namespace armarx
{
    std::string PropertyDefinitionDoxygenFormatter::formatDefinition(
        std::string name,
        std::string description,
        std::string min,
        std::string max,
        std::string default_,
        std::string casesensitivity,
        std::string requirement,
        std::string regex,
        std::vector<std::string> values,
        std::string value)
    {
        std::string output = getFormat();
 
        output = simox::alg::replace_first(output, "%name%",          formatName(getPrefix() + name));
        output = simox::alg::replace_first(output, "%description%",   formatDescription(description));
        output = simox::alg::replace_first(output, "%bounds%",        formatBounds(min, max));
        output = simox::alg::replace_first(output, "%default%",       formatDefault(default_));
        output = simox::alg::replace_first(output, "%casesensitive%", formatCaseSensitivity(casesensitivity));
        output = simox::alg::replace_first(output, "%required%",      formatRequirement(requirement));
        output = simox::alg::replace_first(output, "%regex%",         formatRegex(regex));
        output = simox::alg::replace_first(output, "%values%",        formatValues(values));
 
        return formatDocComment(output);
    }
 
    std::string PropertyDefinitionDoxygenFormatter::getFormat()
    {
        return std::string("\\prop %name%: \n")
               + "%description%<br />\n"
               + "Attributes:\n"
               + "%default%"
               + "%bounds%"
               + "%casesensitive%"
               + "%required%"
               + "%regex%"
               + "%values%";
    }
 
    std::string PropertyDefinitionDoxygenFormatter::formatName(std::string name)
    {
        return name;
    }
 
    std::string PropertyDefinitionDoxygenFormatter::formatDescription(std::string description)
    {
        return description;
    }
 
    std::string PropertyDefinitionDoxygenFormatter::formatBounds(std::string min, std::string max)
    {
        std::string bounds;
 
        if (!min.empty() && max.empty())
        {
            bounds = formatAttribute("Min:", min);
        }
        else if (min.empty() && !max.empty())
        {
            bounds = formatAttribute("Max:", max);
        }
        else if (!min.empty() && !max.empty())
        {
            bounds = formatAttribute("Bounds:", "[" + min + "; " + max + "]");
        }
 
        return bounds;
    }
 
    std::string PropertyDefinitionDoxygenFormatter::formatDefault(std::string default_)
    {
        return formatAttribute("Default:", default_);
    }
 
    std::string PropertyDefinitionDoxygenFormatter::formatCaseSensitivity(std::string caseSensitivity)
    {
        return formatAttribute("Case sensitivity:", caseSensitivity);
    }
 
    std::string PropertyDefinitionDoxygenFormatter::formatRequirement(std::string requirement)
    {
        return formatAttribute("Required:", requirement);
    }
 
    std::string PropertyDefinitionDoxygenFormatter::formatRegex(std::string regex)
    {
        return formatAttribute("Format:", regex);
    }
 
    std::string PropertyDefinitionDoxygenFormatter::formatValues(std::vector<std::string> mapValues)
    {
        std::string valueStrings;
 
        if (mapValues.size() > 0)
        {
            valueStrings += "  - Possible values: {";
 
            std::vector<std::string>::iterator it = mapValues.begin();
 
            while (it != mapValues.end())
            {
                if (!it->empty())
                {
                    valueStrings += formatValue(*it);
                }
 
                ++it;
 
                if (it != mapValues.end())
                {
                    valueStrings += ", ";
                }
            }
 
            valueStrings += "}";
        }
 
        return valueStrings;
    }
 
 
    std::string PropertyDefinitionDoxygenFormatter::formatValue(std::string value)
    {
        return value;
    }
 
 
    std::string PropertyDefinitionDoxygenFormatter::formatAttribute(std::string name, std::string details)
    {
        if (!details.empty())
        {
            std::stringstream strStream;
            strStream << std::setfill(' ') << std::left << std::setw(20) << name;
            strStream << details;
 
            return "  - " + strStream.str() + "\n";
        }
 
        return std::string();
    }
 
 
    std::string PropertyDefinitionDoxygenFormatter::formatHeader(std::string headerText)
    {
        return "\n";
    }
 
 
    std::string PropertyDefinitionDoxygenFormatter::formatDocComment(
        const std::string& text)
    {
        std::string line;
        std::string docComment = "\n";
 
        std::stringstream textStream(text);
 
        while (std::getline(textStream, line, '\n'))
        {
            docComment += "" + line + "\n";
        }
 
        docComment += " \n";
 
        return docComment;
    }
}