MWAWGraphicStyle.hxx

Go to the documentation of this file.

/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */

/* libmwaw
* Version: MPL 2.0 / LGPLv2+
*
* The contents of this file are subject to the Mozilla Public License Version
* 2.0 (the "License"); you may not use this file except in compliance with
* the License or as specified alternatively below. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Major Contributor(s):
* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
* Copyright (C) 2006, 2007 Andrew Ziem
* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
*
*
* All Rights Reserved.
*
* For minor contributions see the git repository.
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
* in which case the provisions of the LGPLv2+ are applicable
* instead of those above.
*/
#ifndef MWAW_GRAPHIC_STYLE
#  define MWAW_GRAPHIC_STYLE
#  include <ostream>
#  include <string>
#  include <vector>

#  include "librevenge/librevenge.h"
#  include "libmwaw_internal.hxx"

class MWAWGraphicStyle
{
public:
  enum LineCap { C_Butt, C_Square, C_Round };
  enum LineJoin { J_Miter, J_Round, J_Bevel };
  enum GradientType { G_None, G_Axial, G_Linear, G_Radial, G_Rectangular, G_Square, G_Ellipsoid };

  struct GradientStop {
    GradientStop(float offset=0.0, MWAWColor const &col=MWAWColor::black(), float opacity=1.0) :
      m_offset(offset), m_color(col), m_opacity(opacity)
    {
    }
    int cmp(GradientStop const &a) const
    {
      if (m_offset < a.m_offset) return -1;
      if (m_offset > a.m_offset) return 1;
      if (m_color < a.m_color) return -1;
      if (m_color > a.m_color) return 1;
      if (m_opacity < a.m_opacity) return -1;
      if (m_opacity > a.m_opacity) return 1;
      return 0;
    }
    friend std::ostream &operator<<(std::ostream &o, GradientStop const &st)
    {
      o << "offset=" << st.m_offset << ",";
      o << "color=" << st.m_color << ",";
      if (st.m_opacity<1.0)
        o << "opacity=" << st.m_opacity*100.f << "%,";
      return o;
    }
    float m_offset;
    MWAWColor m_color;
    float m_opacity;
  };
  struct Pattern {
    Pattern() : m_dim(0,0), m_data(), m_picture(), m_pictureMime(""), m_pictureAverageColor(MWAWColor::white())
    {
      m_colors[0]=MWAWColor::black();
      m_colors[1]=MWAWColor::white();
    }
    Pattern(MWAWVec2i dim, librevenge::RVNGBinaryData const &picture, std::string const &mime, MWAWColor const &avColor) :
      m_dim(dim), m_data(), m_picture(picture), m_pictureMime(mime), m_pictureAverageColor(avColor)
    {
      m_colors[0]=MWAWColor::black();
      m_colors[1]=MWAWColor::white();
    }
    virtual ~Pattern() {}
    bool empty() const
    {
      if (m_dim[0]==0 || m_dim[1]==0) return true;
      if (m_picture.size()) return false;
      if (m_dim[0]!=8 && m_dim[0]!=16 && m_dim[0]!=32) return true;
      return m_data.size()!=size_t((m_dim[0]/8)*m_dim[1]);
    }
    bool getAverageColor(MWAWColor &col) const;
    bool getUniqueColor(MWAWColor &col) const;
    bool getBinary(librevenge::RVNGBinaryData &data, std::string &type) const;

    int cmp(Pattern const &a) const
    {
      int diff = m_dim.cmp(a.m_dim);
      if (diff) return diff;
      if (m_data.size() < a.m_data.size()) return -1;
      if (m_data.size() > a.m_data.size()) return 1;
      for (size_t h=0; h < m_data.size(); ++h) {
        if (m_data[h]<a.m_data[h]) return 1;
        if (m_data[h]>a.m_data[h]) return -1;
      }
      for (int i=0; i<2; ++i) {
        if (m_colors[i] < a.m_colors[i]) return 1;
        if (m_colors[i] > a.m_colors[i]) return -1;
      }
      if (m_pictureAverageColor < a.m_pictureAverageColor) return 1;
      if (m_pictureAverageColor > a.m_pictureAverageColor) return -1;
      if (m_pictureMime < a.m_pictureMime) return 1;
      if (m_pictureMime > a.m_pictureMime) return -1;
      if (m_picture.size() < a.m_picture.size()) return 1;
      if (m_picture.size() > a.m_picture.size()) return -1;
      const unsigned char *ptr=m_picture.getDataBuffer();
      const unsigned char *aPtr=a.m_picture.getDataBuffer();
      if (!ptr || !aPtr) return 0; // must only appear if the two buffers are empty
      for (unsigned long h=0; h < m_picture.size(); ++h, ++ptr, ++aPtr) {
        if (*ptr < *aPtr) return 1;
        if (*ptr > *aPtr) return -1;
      }
      return 0;
    }
    friend std::ostream &operator<<(std::ostream &o, Pattern const &pat)
    {
      o << "dim=" << pat.m_dim << ",";
      if (pat.m_picture.size()) {
        o << "type=" << pat.m_pictureMime << ",";
        o << "col[average]=" << pat.m_pictureAverageColor << ",";
      }
      else {
        if (!pat.m_colors[0].isBlack()) o << "col0=" << pat.m_colors[0] << ",";
        if (!pat.m_colors[1].isWhite()) o << "col1=" << pat.m_colors[1] << ",";
        o << "[";
        for (size_t h=0; h < pat.m_data.size(); ++h)
          o << std::hex << (int) pat.m_data[h] << std::dec << ",";
        o << "],";
      }
      return o;
    }
    MWAWVec2i m_dim;

    MWAWColor m_colors[2];
    std::vector<unsigned char> m_data;
  protected:
    librevenge::RVNGBinaryData m_picture;
    std::string m_pictureMime;
    MWAWColor m_pictureAverageColor;
  };
  MWAWGraphicStyle() :  m_lineWidth(1), m_lineDashWidth(), m_lineCap(C_Butt), m_lineJoin(J_Miter), m_lineOpacity(1), m_lineColor(MWAWColor::black()),
    m_fillRuleEvenOdd(false), m_surfaceColor(MWAWColor::white()), m_surfaceOpacity(0),
    m_shadowColor(MWAWColor::black()), m_shadowOpacity(0), m_shadowOffset(1,1),
    m_pattern(),
    m_gradientType(G_None), m_gradientStopList(), m_gradientAngle(0), m_gradientBorder(0), m_gradientPercentCenter(0.5f,0.5f), m_gradientRadius(1),
    m_backgroundColor(MWAWColor::white()), m_backgroundOpacity(-1), m_bordersList(), m_frameName(""), m_frameNextName(""),
    m_rotate(0), m_extra("")
  {
    m_arrows[0]=m_arrows[1]=false;
    m_flip[0]=m_flip[1]=false;
    m_gradientStopList.push_back(GradientStop(0.0, MWAWColor::white()));
    m_gradientStopList.push_back(GradientStop(1.0, MWAWColor::black()));
  }
  static MWAWGraphicStyle emptyStyle()
  {
    MWAWGraphicStyle res;
    res.m_lineWidth=0;
    return res;
  }
  virtual ~MWAWGraphicStyle() { }
  bool hasLine() const
  {
    return m_lineWidth>0 && m_lineOpacity>0;
  }
  void setSurfaceColor(MWAWColor const &col, float opacity = 1)
  {
    m_surfaceColor = col;
    m_surfaceOpacity = opacity;
  }
  bool hasSurfaceColor() const
  {
    return m_surfaceOpacity > 0;
  }
  void setPattern(Pattern const &pat)
  {
    m_pattern=pat;
  }
  bool hasPattern() const
  {
    return !m_pattern.empty();
  }
  bool hasGradient(bool complex=false) const
  {
    return m_gradientType != G_None && (int) m_gradientStopList.size() >= (complex ? 3 : 2);
  }
  bool hasSurface() const
  {
    return hasSurfaceColor() || hasPattern() || hasGradient();
  }
  void setBackgroundColor(MWAWColor const &col, float opacity = 1)
  {
    m_backgroundColor = col;
    m_backgroundOpacity = opacity;
  }
  bool hasBackgroundColor() const
  {
    return m_backgroundOpacity > 0;
  }
  void setShadowColor(MWAWColor const &col, float opacity = 1)
  {
    m_shadowColor = col;
    m_shadowOpacity = opacity;
  }
  bool hasShadow() const
  {
    return m_shadowOpacity > 0;
  }
  bool hasBorders() const
  {
    return !m_bordersList.empty();
  }
  bool hasSameBorders() const
  {
    if (m_bordersList.empty()) return true;
    if (m_bordersList.size()!=4) return false;
    for (size_t i=1; i<m_bordersList.size(); ++i) {
      if (m_bordersList[i]!=m_bordersList[0])
        return false;
    }
    return true;
  }
  std::vector<MWAWBorder> const &borders() const
  {
    return m_bordersList;
  }
  void resetBorders()
  {
    m_bordersList.resize(0);
  }
  void setBorders(int wh, MWAWBorder const &border);
  friend std::ostream &operator<<(std::ostream &o, MWAWGraphicStyle const &st);
  void addTo(librevenge::RVNGPropertyList &pList, bool only1d=false) const;
  void addFrameTo(librevenge::RVNGPropertyList &pList) const;
  int cmp(MWAWGraphicStyle const &a) const;

  float m_lineWidth;
  std::vector<float> m_lineDashWidth;
  LineCap m_lineCap;
  LineJoin m_lineJoin;
  float m_lineOpacity;
  MWAWColor m_lineColor;
  bool m_fillRuleEvenOdd;
  MWAWColor m_surfaceColor;
  float m_surfaceOpacity;

  MWAWColor m_shadowColor;
  float m_shadowOpacity;
  MWAWVec2f m_shadowOffset;

  Pattern m_pattern;

  GradientType m_gradientType;
  std::vector<GradientStop> m_gradientStopList;
  float m_gradientAngle;
  float m_gradientBorder;
  MWAWVec2f m_gradientPercentCenter;
  float m_gradientRadius;

  bool m_arrows[2];

  //
  // related to the frame
  //

  MWAWColor m_backgroundColor;
  float m_backgroundOpacity;
  std::vector<MWAWBorder> m_bordersList;
  std::string m_frameName;
  std::string m_frameNextName;

  //
  // some transformation: must probably be somewhere else
  //

  float m_rotate;
  bool m_flip[2];

  std::string m_extra;
};
#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab: