fl_AutoNum.h

Go to the documentation of this file.

/* -*- mode: C++; tab-width: 4; c-basic-offset: 4; -*- */
/* AbiWord
 * Copyright (C) 1998,1999 AbiSource, Inc.
 * BIDI Copyright (c) 2001,2002 Tomas Frydrych, Yaacov Akiba Slama
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef FL_AUTONUM_H
#define FL_AUTONUM_H

#include <string>

#include "ut_types.h"
#include "ut_misc.h"
#include "ut_vector.h"
#include "pt_Types.h"
#include "fl_AutoLists.h"

#if defined(__MINGW32__)
#undef snprintf
#define _GLIBCXX_USE_C99_DYNAMIC 1
#endif

#include <vector>

// fwd. decl.
class fl_BlockLayout;
class fl_Layout;
class pf_Frag_Strux;
class PD_Document;
class FV_View;
class UT_UTF8String;

class ABI_EXPORT fl_AutoNum
{
public:
    fl_AutoNum( UT_uint32 id,
                UT_uint32 start,
                pf_Frag_Strux* pItem,
                fl_AutoNum * pParent,
                const gchar * lDelim,
                const gchar * lDecimal,
                FL_ListType lType,
                PD_Document * pDoc,
                FV_View * pView);

    fl_AutoNum( UT_uint32 id,
                UT_uint32 parent_id,
                FL_ListType lType,
                UT_uint32 start,
                const gchar * lDelim,
                const gchar * lDecimal,
                PD_Document * pDoc,
                FV_View * pView);

    ~fl_AutoNum();

    void                        fixHierarchy(void);

    const UT_UCSChar *          getLabel(pf_Frag_Strux*) const;
    void                        addItem(pf_Frag_Strux* pItem);
    FL_ListType                 getType() const;
    UT_uint32                   getValue(pf_Frag_Strux*) const;
    UT_uint32                   getLevel() const { return m_iLevel; }
    UT_uint32                   getNumLabels() const;
    bool                        checkReference(fl_AutoNum * pAuto);

    void                        setLevel(UT_uint32 level) { m_iLevel = level; }
    UT_sint32                   getPositionInList( pf_Frag_Strux* pItem, UT_uint32 depth) const;
    void                        setListType(FL_ListType lType);
    void                        setDelim(const gchar * pszDelim);
    void                        setDelim(const std::string & delim)
    {
        setDelim(delim.c_str());
    }
    const gchar *           getDelim() const;
    void                        setDecimal(const gchar * pszDecimal);
    void                        setDecimal(const std::string & decimal)
    {
        setDecimal(decimal.c_str());
    }
    const gchar *           getDecimal() const;
    bool                        isDirty() const;
    UT_uint16                   getStartValue() const { return m_iStartValue; }

    UT_uint32                   getStartValue32() const;
    void                        setStartValue(UT_uint32 start);

    void                        insertFirstItem(pf_Frag_Strux* pItem,
                                                pf_Frag_Strux* pLast,
                                                UT_uint32 depth,
                                                bool bDoFix=true);
    void                        insertItem(pf_Frag_Strux* pItem, pf_Frag_Strux* pBefore, bool bDoFix = true);
    void                        prependItem(pf_Frag_Strux* pItem, pf_Frag_Strux* pAfter, bool bDoFix = true);
    void                        removeItem(pf_Frag_Strux* pItem);
    pf_Frag_Strux*          getParentItem() const;
    void                        setParentItem(pf_Frag_Strux* pItem);
    bool                                 isContainedByList(pf_Frag_Strux* pItem) const;
    pf_Frag_Strux*          getNthBlock(UT_sint32 i) const;
    pf_Frag_Strux*          getPrevInList(pf_Frag_Strux* pItem) const;

    bool                    isItem(pf_Frag_Strux* pItem) const;
    bool                        doesItemHaveLabel(fl_BlockLayout * pItem) const;
    bool                    isEmpty(void) const;
    pf_Frag_Strux*          getFirstItem(void) const;
    pf_Frag_Strux*          getLastItem(void) const;
    bool                        isLastOnLevel(pf_Frag_Strux* pItem) const;

    fl_AutoNum *                getParent(void) const { return m_pParent; }
    fl_AutoNum *                getActiveParent(void) const;
    fl_AutoNum *                getAutoNumFromSdh(pf_Frag_Strux* sdh);
    const fl_AutoNum *          getAutoNumFromSdh(pf_Frag_Strux* sdh) const;
    void                        fixListOrder(void);
    void                        markAsDirty(void);
    void                        findAndSetParentItem(void);
    void                        setAsciiOffset(UT_uint32 new_asciioffset);

    void                        update(UT_uint32 start);
    bool                        isUpdating(void) const { return m_bUpdatingItems; }
    UT_uint32                   getID() const { return m_iID; }
    UT_uint32                   getParentID() const { return m_iParentID; }
    bool                        isIDSomeWhere(UT_uint32 ID) const;
    static char *               dec2roman(UT_sint32 value, bool lower);
    static char *               dec2ascii(UT_sint32 value, UT_uint32 offset);
    static void                 dec2hebrew(UT_UCSChar labelStr[], UT_uint32 * insPoint, UT_sint32 value);
    void                        getAttributes(std::vector<UT_UTF8String>&v,
                                              bool bEscapeXML) const;
    PD_Document *               getDoc(void) const
    {return m_pDoc;}
    pf_Frag_Strux*           getLastItemInHeiracy(void) const;
protected:
    void                        _setParent(fl_AutoNum * pParent);
    void                        _setParentID(UT_uint32 iParentID);
    void                        _calculateLabelStr(UT_uint32 depth);
    void                        _getLabelstr(   UT_UCSChar labelStr[],
                                                UT_uint32 * insPoint,
                                                UT_uint32 depth,
                                                pf_Frag_Strux* pLayout) const;
    bool                        _updateItems(UT_sint32 start, pf_Frag_Strux* notMe );
    UT_uint32                   _getLevelValue(fl_AutoNum * pAutoNum) const;

    fl_AutoNum *                m_pParent;

    UT_GenericVector<pf_Frag_Strux*> m_pItems;
    PD_Document *               m_pDoc;
    FV_View *                   m_pView;
    FL_ListType                 m_List_Type;
    UT_uint32                   m_iID;
    UT_uint32                   m_iParentID;
    UT_uint32                   m_iLevel;
    UT_uint32                   m_iStartValue;
    UT_uint16                   m_iAsciiOffset;
    bool                        m_bUpdatingItems;
    bool                        m_bDirty;
    UT_sint32                   m_ioffset;
    gchar                   m_pszDecimal[80]; // BAD BAD HARDCODED ARRAY LENGTHS
    gchar                   m_pszDelim[80];
    gchar                   m_pszIndent[80];
    bool                        m_bWordMultiStyle;
    pf_Frag_Strux*          m_pParentItem;
};

#endif