Obj.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2012 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);

         size_t Size () const;

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

         UInt32 GetObjNum () const;

         UInt16 GetGenNum () const;

         size_t 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 -----------------------------------------------------

#ifdef SWIG
         std::vector<unsigned char> GetBuffer () const;
#else
         const UChar* GetBuffer () const;
#endif

         UString GetAsPDFText() const;

#ifndef SWIG
         void GetAsPDFText(UString& out_str) const;
#endif

         void SetString(const UChar* value, size_t 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 (size_t index) const;

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

         Obj InsertArray (size_t pos);

         Obj InsertBool (size_t pos, bool value);

         Obj InsertDict (size_t pos);

         Obj InsertNumber (size_t pos, double value);

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

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

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

         Obj InsertNull(size_t pos);

         Obj Insert(size_t pos, Obj obj);

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

         Obj InsertMatrix(size_t 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 (size_t pos);


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

         size_t GetRawStreamLength () const;

         Filters::Filter GetRawStream (bool decrypt) const;

         Filters::Filter GetDecodedStream () const;
        
         void SetStreamData( 
                 const char* data, 
                 const size_t data_size, 
                 Filters::Filter filter_chain = Filters::Filter() );

        // 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;

        #ifndef SWIGHIDDEN
         Obj(TRN_Obj impl);
        TRN_Obj mp_obj;
private:
        mutable TRN_SDFDoc temp_doc;
        #endif
};



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



#include <Impl/SDFDoc.inl>
#endif  

---

© 2002-2012 PDFTron Systems Inc.