Obj.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2008 by PDFTron Systems Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------

#ifndef   H_CPPSDFObj
#define   H_CPPSDFObj

#include <Common/Exception.h>
#include <Common/UString.h>
#include <Common/Matrix2D.h>
#include <Filters/FilterWriter.h>
#include <Filters/Filter.h>


namespace pdftron { 
        namespace SDF {

class DictIterator;

class Obj 
{
public:

        // Common methods for all objects -----------------------------------------------

        enum Type 
        {
                e_null,
                e_bool,
                e_number,
                e_name,
                e_string,
                e_dict, 
                e_array,
                e_stream
        };

         Type GetType () const;

         bool IsBool () const;

         bool IsNumber () const;

         bool IsNull () const;

         bool IsString () const;

         bool IsName () const;

         bool IsIndirect () const;

         bool IsContainer () const;

         bool IsDict () const;

         bool IsArray () const;

         bool IsStream () const;

         class SDFDoc& GetDoc () const;

         void Write(Filters::FilterWriter& stream);

         ULong Size () const;

        // Indirect Methods -------------------------------------------------------------

         ULong GetObjNum () const;

         UShort GetGenNum () const;

         ULong GetOffset () const;

         bool IsFree () const;

         void SetMark (bool mark);

         bool IsMarked () const;

         bool IsLoaded () const;


        // Boolean Specific Methods ----------------------------------------------------

         bool GetBool () const;

         void SetBool (bool b);

        // Number Specific Methods -----------------------------------------------------

         double GetNumber () const;

         void SetNumber (double n);


        // String Specific Methods -----------------------------------------------------

         const UChar* GetBuffer () const;

         void GetAsPDFText(UString& out_str) const;

         void SetString(const UChar* value, UInt size);

         void SetString(const UString& str);

        // Name Specific Methods -------------------------------------------------------

         const char* GetName () const;

         void SetName (const char* name); 


        // Dictionary Specific Methods -------------------------------------------------

         DictIterator GetDictIterator ();

         DictIterator Find (const char* key);

         Obj FindObj (const char* key);

         DictIterator Get (const char* key);

         Obj PutName (const char* key, const char* name);

         Obj PutArray (const char* key);

         Obj PutBool (const char* key, bool value);

         Obj PutDict (const char* key);

         Obj PutNumber (const char* key, double value);

         Obj PutString (const char* key, const char* value);

         Obj PutString (const char* key, const char* value, int size);

         Obj PutText(const char* key, const UString& value);

         void PutNull (const char* key);

         Obj Put(const char* key, Obj obj);

         Obj PutRect (const char* key, double x1, double y1, double x2, double y2);

         Obj PutMatrix(const char* key, const Common::Matrix2D& value);

         void Erase (const char* key);

         void Erase (DictIterator pos);
        
         bool Rename (const char* old_key, const char* new_key);


        // Array Specific Methods ------------------------------------------------------

         Obj GetAt (UInt index) const;

         Obj InsertName (UInt pos, const char* name);

         Obj InsertArray (UInt pos);

         Obj InsertBool (UInt pos, bool value);

         Obj InsertDict (UInt pos);

         Obj InsertNumber (UInt pos, double value);

         Obj InsertString (UInt pos, const char* value);

         Obj InsertString (UInt pos, const char* value, int size);

         Obj InsertText(UInt pos, const UString& value);

         Obj InsertNull(UInt pos);

         Obj Insert(UInt pos, Obj obj);

         Obj InsertRect (UInt pos, double x1, double y1, double x2, double y2);

         Obj InsertMatrix(UInt pos, Common::Matrix2D& value);

         Obj PushBackName (const char* name);

         Obj PushBackArray ();

         Obj PushBackBool (bool value);

         Obj PushBackDict ();

         Obj PushBackNumber (double value);

         Obj PushBackString (const char* value);

         Obj PushBackString (const char* value, int size);

         Obj PushBackText (const UString& value);

         Obj PushBackNull ();

         Obj PushBack(Obj obj);

         Obj PushBackRect (double x1, double y1, double x2, double y2);

         Obj PushBackMatrix(Common::Matrix2D& value);
        
         void EraseAt (UInt pos);


        // Stream Specific Methods -----------------------------------------------------

         ULong GetRawStreamLength () const;

         Filters::Filter GetRawStream (bool decrypt) const;

         Filters::Filter GetDecodedStream () const;


        // Support methods ----------------------------------------------------------------

         Obj() : mp_obj(0) {}
         Obj(const Obj& c) : mp_obj(c.mp_obj) {}
         Obj& operator=(const Obj& c) {mp_obj=c.mp_obj; return *this;}

         operator bool () { return mp_obj!=0;}
        
         bool IsEqual(const Obj& to) const;
         bool operator ==(const Obj& to) const;

         Obj(TRN_Obj impl);
        TRN_Obj mp_obj;
private:
        mutable TRN_SDFDoc temp_doc;
};



        };      // namespace SDF
};      // namespace pdftron



#include <Impl/SDFDoc.inl>
#endif  

---

© 2002-2008 PDFTron Systems Inc.