prop_types.cpp

Go to the documentation of this file.

/*
 * prop_types.cpp
 *
 * Copyright (C) 2007,2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Property type helper implementation.  See prop_types.h
 */

// includes --------------------------------------------------------------------
#include "prop_types.h"         // always include our own header first!

#include <sstream>

#include "common/wave_ex.h"

#include "util/parsing.h"


namespace objtree {


static const char s_escape                      = (char) 205; // '\xCD'


////////////////////////////////////////////////////////////////////////////////
//
//      static helper methods
//
////////////////////////////////////////////////////////////////////////////////

static bool
getBoolean
(
IN const dictionary_t& data,
IN const char * key
)
{
        ASSERT(key, "null");

        const char * val = getOptionalValue(data, key, "false");
        return !strcmp("true", val);
}



static void
addBooleanIfTrue
(
IO std::ostream& out,
IN const char * key,
IN bool val
)
{
        ASSERT(out.good(), "bad");
        ASSERT(key, "null");

        if (val) {
                out << " " << key << " true";
        }
}



static void
addPrettyIfTrue
(
IO std::ostream& out,
IN const char * key,
IN bool val
)
{
        if (val) {
                out << " " << key;
        }
}


static std::string
escape
(
IN const char * p
)
{
        ASSERT(p, "null");

        std::string out;
        for (; *p; ++p) {
                char a = *p;
                if (' ' == a) {
                        a = s_escape; 
                }
                out += a;
        }
        return out;
}



static std::string
unescape
(
IN const char * p
)
{
        ASSERT(p, "null");

        std::string out;
        for (; *p; ++p) {
                char a = *p;
                if (s_escape == a)
                        a = ' ';
                out += a;
        }

        return out;
}



static void
validateColorComponent
(
IN int x
)
{
        if (x < 0 || x > 255) {
                WAVE_EX(wex);
                wex << "Invalid color component (should be 0-255): " << x;
        }
}



static void
addColorComponent
(
IO std::string& s,
IN const char * tag,
IN int x,
IN int default_value
)
{
        ASSERT(tag, "null tag");
        validateColorComponent(x);
        validateColorComponent(default_value);

        if (x == default_value)
                return;         // don't write default values

        char buffer[4];         // safe for 0-255
        snprintf(buffer, 4, "%d", x);
        s += tag;
        s += " ";
        s += buffer;
        s += " ";
}




////////////////////////////////////////////////////////////////////////////////
//
//      public API
//
////////////////////////////////////////////////////////////////////////////////

color_t
getColorFromString
(
IN const char * text
)
{
        ASSERT(text, "null string in getColorFromString()");

        dictionary_t data;
        getDictionaryFromString(text, "color data", data);

        color_t c;              // return value
        c.red = atoi(getOptionalValue(data, "r", "0"));
        c.green = atoi(getOptionalValue(data, "g", "0"));
        c.blue = atoi(getOptionalValue(data, "b", "0"));
        c.alpha = atoi(getOptionalValue(data, "a", "255"));

        validateColorComponent(c.red);
        validateColorComponent(c.green);
        validateColorComponent(c.blue);
        validateColorComponent(c.alpha);

        return c;
}



void
getStringFromColor
(
IN const color_t& c,
OUT std::string& s
)
{
        s.clear();

        addColorComponent(s, "r", c.red, 0);
        addColorComponent(s, "g", c.green, 0);
        addColorComponent(s, "b", c.blue, 0);
        addColorComponent(s, "a", c.alpha, 255);
}



void
getFontFromString
(
IN const char * info,
OUT font_t& font
)
{
        ASSERT(info, "null");
        font.clear();

        dictionary_t data;
        getDictionaryFromString(info, "font information", data);

        font.face_name = unescape(getOptionalValue(data, "faceName", "Helvetica"));
        font.point_size = atof(getOptionalValue(data, "size", "12.0"));
        font.bold = getBoolean(data, "bold");
        font.italic = getBoolean(data, "italic");
        font.underline = getBoolean(data, "underline");
        font.strikeout = getBoolean(data, "strikeout");
}



void
getStringFromFont
(
IN const font_t& font,
OUT std::string& out
)
{
        out.clear();

        std::ostringstream oss;
        oss << "faceName " << escape(font.face_name.c_str());
        oss << " size " << font.point_size;
        addBooleanIfTrue(oss, "bold", font.bold);
        addBooleanIfTrue(oss, "italic", font.italic);
        addBooleanIfTrue(oss, "underline", font.underline);
        addBooleanIfTrue(oss, "strikeout", font.strikeout);

        out = oss.str();
}



void
getDisplayStringFromFont
(
IN const font_t& font,
OUT std::string& out
)
{
        out.clear();

        std::ostringstream oss;
        oss << font.face_name << " " << font.point_size << "pt";
        addPrettyIfTrue(oss, "bold", font.bold);
        addPrettyIfTrue(oss, "italic", font.italic);
        addPrettyIfTrue(oss, "underline", font.underline);
        addPrettyIfTrue(oss, "strikeout", font.strikeout);

        out = oss.str();
}


};      // objtree namespace