MSWStruct.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.
*/

/*
 * Class to read/store the MSW structures
 */

#ifndef MSW_STRUCT
#  define MSW_STRUCT

#include <iostream>
#include <string>
#include <vector>

#include "libmwaw_internal.hxx"

#include "MWAWFont.hxx"
#include "MWAWParagraph.hxx"

class MWAWInputStream;
typedef shared_ptr<MWAWInputStream> MWAWInputStreamPtr;
class MWAWFontConverter;
typedef shared_ptr<MWAWFontConverter> MWAWFontConverterPtr;
class MWAWSection;

namespace MSWStruct
{
MWAWBorder getBorder(int val, std::string &extra);

struct Font {
  enum { NumFlags =9 };

  Font(): m_font(MWAWFont(-1,0)), m_size(0), m_value(0), m_picturePos(0), m_unknown(0), m_extra("") {
    for (int i = 0; i < NumFlags; i++) m_flags[i]=Variable<int>(0);
  }

  void insert(Font const &font, Font const *styleFont=0);

  void updateFontToFinalState(Font const *styleFont=0);

  friend std::ostream &operator<<(std::ostream &o, Font const &font);

  int cmp(Font const &oth) const {
    int diff = m_font.get().cmp(oth.m_font.get());
    if (diff) return diff;
    if (m_size.get() < oth.m_size.get()) return -1;
    if (m_size.get() > oth.m_size.get()) return 1;
    diff = m_value.get()-oth.m_value.get();
    if (diff) return diff;
    for (int i = 0; i < NumFlags; i++) {
      diff = m_flags[i].get()-oth.m_flags[i].get();
      if (diff) return diff;
    }
    if (m_picturePos.get()<oth.m_picturePos.get()) return -1;
    if (m_picturePos.get()>oth.m_picturePos.get()) return 1;
    diff = m_unknown.get()-oth.m_unknown.get();
    if (diff) return diff;
    return 0;
  }
  Variable<MWAWFont> m_font;
  Variable<float> m_size;
  Variable<int> m_value;
  Variable<int> m_flags[NumFlags];
  Variable<long> m_picturePos;
  Variable<int> m_unknown;
  std::string m_extra;
};

struct Section {
  Section() : m_id(-1), m_type(0), m_paragraphId(-9999), m_col(1),
    m_colSep(0.5), m_colBreak(false), m_flag(0), m_extra("") {
  }
  MWAWSection getSection(double pageWidth) const;

  void insert(Section const &sec) {
    m_id.insert(sec.m_id);
    m_type.insert(sec.m_type);
    m_paragraphId.insert(sec.m_paragraphId);
    m_col.insert(sec.m_col);
    m_colSep.insert(sec.m_colSep);
    m_colBreak.insert(sec.m_colBreak);
    m_flag.insert(sec.m_flag);
    m_extra+=sec.m_extra;
  }
  bool read(MWAWInputStreamPtr &input, long endPos);
  bool readV3(MWAWInputStreamPtr &input, long endPos);

  friend std::ostream &operator<<(std::ostream &o, Section const &section);

  Variable<int> m_id;
  Variable<int> m_type;
  Variable<int> m_paragraphId;
  Variable<int> m_col;
  Variable<float> m_colSep;
  Variable<bool> m_colBreak;
  Variable<int> m_flag;
  std::string m_extra;
};

struct Table {
  struct Cell;
  Table() : m_height(0), m_justify(MWAWParagraph::JustificationLeft), m_indent(0),
    m_columns(), m_cells(), m_extra("") {
  }
  void insert(Table const &table) {
    m_height.insert(table.m_height);
    m_justify.insert(table.m_justify);
    m_indent.insert(table.m_indent);
    m_columns.insert(table.m_columns);
    size_t tNumCells = table.m_cells.size();
    if (tNumCells > m_cells.size())
      m_cells.resize(tNumCells, Variable<Cell>());
    for (size_t i=0; i < tNumCells; i++) {
      if (!m_cells[i].isSet())
        m_cells[i] = table.m_cells[i];
      else if (table.m_cells[i].isSet())
        m_cells[i]->insert(*table.m_cells[i]);
    }
    m_extra+=table.m_extra;
  }
  bool read(MWAWInputStreamPtr &input, long endPos);
  Variable<Cell> &getCell(int id);

  friend std::ostream &operator<<(std::ostream &o, Table const &table);

  Variable<float> m_height;
  Variable<MWAWParagraph::Justification> m_justify;
  Variable<float> m_indent;
  Variable<std::vector<float> > m_columns;
  std::vector<Variable<Cell> > m_cells;
  std::string m_extra;

  struct Cell {
    Cell() : m_borders(), m_backColor(1.0f), m_extra("") {
    }
    void insert(Cell const &cell) {
      size_t cNumBorders = cell.m_borders.size();
      if (cNumBorders > m_borders.size())
        m_borders.resize(cNumBorders);
      for (size_t i=0; i < cNumBorders; i++)
        if (cell.m_borders[i].isSet()) m_borders[i]=*cell.m_borders[i];
      m_backColor.insert(cell.m_backColor);
      m_extra+=cell.m_extra;
    }
    bool hasBorders() const {
      for (size_t i = 0; i < m_borders.size(); i++)
        if (m_borders[i].isSet() && m_borders[i]->m_style != MWAWBorder::None)
          return true;
      return false;
    }
    friend std::ostream &operator<<(std::ostream &o, Cell const &cell);
    std::vector<Variable<MWAWBorder> > m_borders;
    Variable<float> m_backColor;
    std::string m_extra;
  };
};

struct ParagraphInfo {
  ParagraphInfo() : m_type(0), m_dim(), m_numLines(-1), m_error("") {
  }
  bool isLineSet() const {
    return *m_numLines!=0;
  }
  bool isEmpty() const {
    if (*m_numLines || *m_type) return false;
    if (!m_dim.isSet()) return true;
    if ((*m_dim)[0] > 0 || (*m_dim)[1] > 0) return false;
    return true;
  }
  bool read(MWAWInputStreamPtr &input, long endPos, int vers);
  friend std::ostream &operator<<(std::ostream &o, ParagraphInfo const &pInfo) {
    // find also pInfo.m_type&0x40 : ?
    if (*pInfo.m_type&0xd0) o << "type?=" << ((*pInfo.m_type&0xd0)>>4) << ",";
    if (*pInfo.m_type&0x0f) o << "#unkn=" << (*pInfo.m_type&0xf) << ",";
    if (pInfo.m_dim.isSet()) {
      if ((*pInfo.m_dim)[0] > 0)
        o << "width=" << (*pInfo.m_dim)[0] << ",";
      if ((*pInfo.m_dim)[1] > 0) {
        o << "height=" << (*pInfo.m_dim)[1];
        if (*pInfo.m_type&0x20)
          o << "[total]";
        o << ",";
      }
    }
    if (pInfo.m_numLines.isSet() && *pInfo.m_numLines!=-1 && *pInfo.m_numLines!=1)
      o << "nLines=" << *pInfo.m_numLines << ",";
    if (pInfo.m_error.length()) o << pInfo.m_error << ",";
    return o;
  }
  void insert(ParagraphInfo const &pInfo);
  Variable<int> m_type;
  Variable<Vec2f> m_dim;
  Variable<int> m_numLines;
  std::string m_error;
};

struct Paragraph : public MWAWParagraph {
  Paragraph(int version) : MWAWParagraph(), m_version(version), m_styleId(-1000),
    m_deletedTabs(), m_info(), m_font(), m_font2(), m_modFont(), m_section(),
    m_bordersStyle(), m_inCell(false), m_tableDef(false), m_table() {
    m_tabsRelativeToLeftMargin=false;
  }
  void insert(Paragraph const &para, bool insertModif=true);
  bool read(MWAWInputStreamPtr &input, long endPos);
  bool getFont(Font &font, Font const *styleFont=0) const;
  bool inTable() const {
    return m_inCell.get();
  }
  friend std::ostream &operator<<(std::ostream &o, Paragraph const &ind);

  void print(std::ostream &o, MWAWFontConverterPtr converter) const;

  int getNumLines() const {
    return m_info.get().m_numLines.get();
  }
  int m_version;
  Variable<int> m_styleId;
  Variable<std::vector<float> > m_deletedTabs;
  Variable<ParagraphInfo> m_info;
  Variable<Font> m_font, m_font2 , m_modFont ;
  Variable<Section> m_section;
  Variable<MWAWBorder> m_bordersStyle;
  Variable<bool> m_inCell;
  Variable<bool> m_tableDef;
  Variable<Table> m_table;
};
}
#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab: