DrawSpecs.hpp

// sciplot - a modern C++ scientific plotting library powered by gnuplot
// https://github.com/sciplot/sciplot
//
// Licensed under the MIT License <http://opensource.org/licenses/MIT>.
//
// Copyright (c) 2018-2021 Allan Leal
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
// sciplot includes
#include <sciplot/ColumnIndex.hpp>
#include <sciplot/Utils.hpp>
#include <sciplot/specs/FillSpecsOf.hpp>
#include <sciplot/specs/FilledCurvesSpecsOf.hpp>
#include <sciplot/specs/LineSpecsOf.hpp>
#include <sciplot/specs/PointSpecsOf.hpp>
 
namespace sciplot
{
 
class DrawSpecs : public LineSpecsOf<DrawSpecs>, public PointSpecsOf<DrawSpecs>, public FillSpecsOf<DrawSpecs>, public FilledCurvesSpecsOf<DrawSpecs>
{
  public:
    DrawSpecs(std::string what, std::string use, std::string with);
 
    auto label(std::string text) -> DrawSpecs&;
 
    auto labelFromColumnHeader() -> DrawSpecs&;
 
    auto labelFromColumnHeader(int icolumn) -> DrawSpecs&;
 
    auto labelNone() -> DrawSpecs&;
 
    auto labelDefault() -> DrawSpecs&;
 
    auto xtics(ColumnIndex icol) -> DrawSpecs&;
 
    auto ytics(ColumnIndex icol) -> DrawSpecs&;
 
    auto repr() const -> std::string;
 
  private:
    std::string m_what;
 
    std::string m_using;
 
    std::string m_with;
 
    std::string m_title;
 
    std::string m_xtic;
 
    std::string m_ytic;
};
 
inline DrawSpecs::DrawSpecs(std::string what, std::string use, std::string with)
    : m_what(what), m_using(use), m_with(with)
{
    lineWidth(internal::DEFAULT_LINEWIDTH);
}
 
inline auto DrawSpecs::label(std::string text) -> DrawSpecs&
{
    m_title = "title '" + text + "'";
    return *this;
}
 
inline auto DrawSpecs::labelFromColumnHeader() -> DrawSpecs&
{
    m_title = "title columnheader";
    return *this;
}
 
inline auto DrawSpecs::labelFromColumnHeader(int icolumn) -> DrawSpecs&
{
    m_title = "title columnheader(" + std::to_string(icolumn) + ")";
    return *this;
}
 
inline auto DrawSpecs::labelNone() -> DrawSpecs&
{
    m_title = "notitle";
    return *this;
}
 
inline auto DrawSpecs::labelDefault() -> DrawSpecs&
{
    m_title = "";
    return *this;
}
 
inline auto DrawSpecs::xtics(ColumnIndex icol) -> DrawSpecs&
{
    m_xtic = "xtic(stringcolumn(" + icol.value + "))"; // xtic(stringcolumn(1)) or xtic(stringcolumn('Name'))
    return *this;
}
 
inline auto DrawSpecs::ytics(ColumnIndex icol) -> DrawSpecs&
{
    m_ytic = "ytic(stringcolumn(" + icol.value + "))"; // ytic(stringcolumn(1)) or ytic(stringcolumn('Name'))
    return *this;
}
 
inline auto DrawSpecs::repr() const -> std::string
{
    std::string use = m_using;
    if (m_xtic.size()) use += ":" + m_xtic;
    if (m_ytic.size()) use += ":" + m_ytic;
 
    std::stringstream ss;
    ss << m_what << " ";
    ss << gnuplot::optionValueStr("using", use);
    ss << m_title << " ";
    ss << gnuplot::optionValueStr("with", m_with);
    ss << FilledCurvesSpecsOf<DrawSpecs>::repr() << " ";
    ss << LineSpecsOf<DrawSpecs>::repr() << " ";
    ss << PointSpecsOf<DrawSpecs>::repr() << " ";
    ss << FillSpecsOf<DrawSpecs>::repr() << " ";
    return internal::removeExtraWhitespaces(ss.str());
}
 
} // namespace sciplot