---

pdf::core::CFile Class Reference

a PDF file. More...

#include <File.hh>

List of all members.

Public Types

• typedef CObjVec::const_iterator iterator
• typedef CObjVec::value_type value_type

Public Methods

• CFile ()
• ~CFile ()
• const CObjRef AddObj (CObject *object)
• std::ostream & Write (std::ostream &file, const CObjRef &catalog, const CObjRef *doc_info) const
• CObject * operator[] (const CObjRef &ref)
• const CObject * operator[] (const CObjRef &ref) const

Private Types

• typedef std::vector< boost::shared_ptr<
  CRefObj > > CObjVec

Private Attributes

• CObjVec m_objects

---

Detailed Description

a PDF file.

the PDF file class contains a list of PDF referenced objects. objects are added to the file to register an object identifier and become a referenced object. the main purpose of this class is to generate identifier number of the objects.

---

Member Typedef Documentation

typedef std::vector<boost::shared_ptr<CRefObj> > pdf::core::CFile::CObjVec [private]

just shortcut

typedef CObjVec::const_iterator pdf::core::CFile::iterator

immutable iterator

typedef CObjVec::value_type pdf::core::CFile::value_type

shortcut

---

Constructor & Destructor Documentation

pdf::core::CFile::CFile (    )

constructor do nothing { }

pdf::core::CFile::~CFile (    )

destructor also do nothing { }

---

Member Function Documentation

const CObjRef pdf::core::CFile::AddObj (  CObject *    object )

this function will register an identifier to an object and add it to the file. the identifier is base on the number of object added. the reference to the object is returned. Returns: the reference to the object { CRefObj *ref = new CRefObj( m_objects.size( ) + 1, object ) ; m_objects.push_back( boost::shared_ptr<CRefObj>( ref ) ) ; return ref->GetRef( ) ; }

std::ostream & pdf::core::CFile::Write (  std::ostream &    file, const CObjRef &    catalog, const CObjRef *    doc_info )  const

write the whole PDF file into a output stream. this function will write all the PDF file header, the PDF objects it contains and the PDF trailer to the file. Parameters: file  the output stream. can be any stream except standard output. catalog  the reference of the PDF catalog object. it must appear in the trailer. doc_info  a reference to the PDF document info dictionary. it is optional. if it is null, the document has no info dictionary. Exceptions: pdf::util::CFileError  object if file.tellp() returns -1. using byte stream (e.g. cout, pipes/fifo or sockets) as file will cause this. use normal file instead. { using namespace std ; // PDF version string file << "%PDF-1.4" << endl ; // write a 4 byte binary data comment char comment[] = "%\xfa\xce\xbe\xad" ; file << comment << endl ; std::vector<int> offsets ; for ( iterator i = m_objects.begin( ) ; i != m_objects.end( ) ; ++i ) { streampos p = file.tellp( ) ; // if we tellp( ) fails, throw exception if ( p == streampos( -1 ) ) throw util::CFileError( "cannot get offset of output file" ) ; // save the file position offsets.push_back( p ) ; // write the object to the file file << **i ; } streampos xref_offset = file.tellp( ) ; if ( xref_offset == streampos( -1 ) ) throw util::CFileError( "cannot get offset of output file" ) ; file << "xref\n0 " << offsets.size( ) + 1 << "\n0000000000 65535 f \n" ; for ( std::vector<int>::iterator i = offsets.begin( ) ; i != offsets.end( ) ; ++i ) { file << setw( 10 ) << setfill( '0' ) << *i << " 00000 n \n" ; } CDictionary trailer ; trailer.AddPair( "Size", new CNumber( offsets.size( ) + 1 ) ) ; trailer.AddPair( "Root", catalog.Dup( ) ) ; if ( doc_info != 0 ) trailer.AddPair( "Info", doc_info->Dup( ) ) ; file << "trailer\n" << trailer << endl ; file << "startxref" << endl << xref_offset << endl << "%%EOF" << endl ; return file ; }

CObject * pdf::core::CFile::operator[] (  const CObjRef &    ref )

access to the contained objects via its identifier. { CObjVec::size_type index = ref.ID( ) - 1 ; assert( index >= 0 && index < m_objects.size( ) ) ; return m_objects[index].get( ) ; }

const CObject * pdf::core::CFile::operator[] (  const CObjRef &    ref )  const

access to the contained objects via its identifier. { CObjVec::size_type index = ref.ID( ) - 1 ; assert( index >= 0 && index < m_objects.size( ) ) ; return m_objects[index].get( ) ; }

---

Member Data Documentation

CObjVec pdf::core::CFile::m_objects [private]

the list of objects

---

The documentation for this class was generated from the following files:

• File.hh
• File.cc

---