hdicoreFileFormat.h

Go to the documentation of this file.

 
#ifndef __HDI_CORE_FILE_FORMAT__
#define __HDI_CORE_FILE_FORMAT__
 
#if defined(HDI_CORE_AIP_MODE)
 
#include <vector>
 
#include "hdicoreTypes.h"
 
namespace hdi
{
    namespace core
    {
        class FileFormat
        {
            public:
                typedef std::vector<std::string> ExtVector;
                
                enum Options
                {
                    UnknownOptions                  = 0,
                    
                    // Read the file, creating artwork in a new document. The format is included in the File > Open file
                    // types. Use when adding a format.
                    ReadOption                      = 1 << 0,
                    
                    // Write the documentís contents to a file in a non-Illustrator format. The format is included in
                    // the File > Export file types. Use when adding a format.
                    ExportOption                    = 1 << 1,
                    
                    // Write the documentís contents to a file in a format from which is can be read back into
                    // Illustrator without loss of data. The format is included in the File > Save As file types. Use
                    // when adding a format.
                    WriteOption                     = 1 << 9,
                    
                    // Read the file and embed artwork to the current document. The format is included in the File >
                    // Import file types. Use when adding a format.
                    ImportArtOption                 = 1 << 2,
                    
                    // Read the file and embed artwork to the current document. This is the same as ImportArtOption. Use
                    // when adding a format.
                    PlaceArtOption                  = 1 << 3,
                    
                    // Allows "Template" to be checked in the Place dialog when linking or embedding a file of this type,
                    // so the art is placed in a template layer. Use when adding a format.
                    ConvertTemplateOption           = 1 << 7,
                    
                    // Make a link from the contents of a file to an Illustrator document. Use when adding a format.
                    LinkArtOption                   = 1 << 8,
                    
                    // Unused!
                    ImportStylesOption              = 1 << 4,
                    
                    // Unused!
                    SuppliesPrintRecordOptionOption = 1 << 5,
                    
                    // Makes this the default format for all documents. If specified by more than one plug-in, the last
                    // one becomes the default. Use when adding a format.
                    IsDefaultOptionOption           = 1 << 6,
                    
                    // The plug-in will not respond to the FileFormatCheckMessageType message. (For example, the
                    // PhotoShop adapter plug-in always returns that no error occurred. Use when adding a format.
                    NoAutoCheckFormatOption         = 1 << 10,
                    
                    // Read the file, creating artwork in a new template layer in the current document. Not used for
                    // adding a format.
                    CreateTemplateLayerOption       = 1 << 11,
                    
                    // Handle the extended data passed in a FileFormatGoMessageType message for a placement request. Use
                    // when adding a format.
                    HasExtendedDataOption           = 1 << 12,
                    
                    // This file format supplies its own startup objects (colors, patterns, and so on), Illustrator does
                    // not copy the startup file. Use when adding a format.
                    SkipStartupObjectsOptionOption  = 1 << 13,
                    
                    // Disable warning dialogs upon read and write. Not used for adding a format.
                    NoWarningOptionOption           = 1 << 14,
                    
                    // Write the current document to a copy of the file it was loaded from. Not used for adding a format.
                    SaveCopyOptionOption            = 1 << 15,
                    
                    // Prevents this file format from appearing in the file selection menu of the Open and Place dialogs.
                    // Use when adding a format.
                    SuppressUIOption                = 1 << 21,
                    
                    // Set in combination with \c #kFileFormatWrite for a Save As operation, to distinguish it from Save.
                    // Not used for adding a format.
                    WriteAsOption                   = 1 << 22,
                    
                    // Always receive the Check message, even for operations this plug-in does not support. Allows an
                    // opportunity to explicitly reject operations on files matching this plug-in's type. Use when
                    // adding a format.
                    CheckAlwaysOption               = 1 << 23,
                    
                    // Handle additional parameters passed in the FileFormatMessage::actionParam() method. These
                    // supplement the usual parameters of the file format, and may not be complete. Can be used, for
                    // instance, for scripting or optimizing. If set in the FileFormatGoMessageType message for a plug-in
                    // that does not handle the option, you can ignore it. Not used for adding a format.
                    ContainsPartialParametersOption = 1 << 24,
                    
                    // Import only the SLO composite fonts. Do not import artwork or other global objects, and do not
                    // perform font fauxing. Not used for adding a format.
                    ImportCompositeFontsOption      = 1 << 25,
                    
                    // Treat the file as stationary - that is, open a copy with an Untitled name. Use only in conjunction
                    // with ReadOption. Not used for adding a format.
                    OpenUntitledCopyOption          = 1 << 26,
                    
                    // An option for the native (PGF) AI File Format Writer, telling it to write out only the indicated
                    // palettes and the global objects, directly or indirectly. Not used for adding a format.
                    WriteSwatchLibraryOption        = 1 << 27,
                    
                    // An option for the native (PGF) AI File Format Writer, telling it to write out only the indicated
                    // palettes and the global objects, directly or indirectly. Not used for adding a format.
                    WriteBrushLibraryOption         = 1 << 28,
                    
                    // An option for the native (PGF) AI File Format Writer, telling it to write out only the indicated
                    // palettes and the global objects, directly or indirectly. Not used for adding a format.
                    WriteStyleLibraryOption         = 1 << 29,
                    
                    // An option for the native (PGF) AI File Format Writer, telling it to write out only the indicated
                    // palettes and the global objects, directly or indirectly. Not used for adding a format.
                    WriteSymbolLibraryOption        = 1 << 30
                };
                
                enum ExtendedOptions
                {
                    NoExtendedOptions                   = 0,
                    SaveMultiArtboardsExtendedOption    = 1 << 0
                };
                
                struct AddData
                {
                    int32_t type;
                    
                    std::string title;
                    
                    int32_t titleOrder;
                    
                    ExtVector extensions;
                    
                    AddData();
                    
                    AddData(const AddData& d_);
                    
                    virtual ~AddData();
                    
                    AddData& operator=(const AddData& rhs_);
                };
        
                typedef std::unique_ptr<AddData> AddDataUP;
                typedef std::shared_ptr<AddData> AddDataSP;
                typedef std::weak_ptr<AddData> AddDataWP;
 
                FileFormat();
            
                FileFormat(const FileFormat& ff_);
 
                FileFormat(const AIFileFormatHandle aiFileFormat_);
            
                FileFormat(
                    const std::string& name_,
                    const AddData& data_,
                    const Options opt_,
                    const ExtendedOptions extOpt_
                );
 
                virtual ~FileFormat();
                
                virtual FileFormat& operator=(const FileFormat& rhs_);
 
                virtual bool isEmpty() const;
 
                virtual AIFileFormatHandle aiFileFormatHandle() const;
                
                virtual bool operator==(const FileFormat& rhs_) const;
                
                virtual bool operator!=(const FileFormat& rhs_) const;
                
                std::string name() const;
                
                std::string title() const;
                
                int32_t macType() const;
                
                ExtVector extensions() const;
                
                Options options() const;
                
                void setOptions(const Options opt_);
 
 
            private:
                friend class Illustrator;
                friend void* __accessImpl(const FileFormat&);
 
                void* __data;
                
                void* __impl() const;
                
                bool __add(std::string&, AddData&, Options&, ExtendedOptions&) const;
        };
        
        typedef std::unique_ptr<FileFormat> FileFormatUP;
        typedef std::shared_ptr<FileFormat> FileFormatSP;
        typedef std::weak_ptr<FileFormat> FileFormatWP;
        
        extern void* __accessImpl(const FileFormat&);
    }
}
 
hdi::core::FileFormat::Options operator|(
    const hdi::core::FileFormat::Options lhs_,
    const hdi::core::FileFormat::Options rhs_
);
 
hdi::core::FileFormat::Options& operator|=(
    hdi::core::FileFormat::Options& lhs__,
    const hdi::core::FileFormat::Options rhs_
);
 
#endif
// HDI_CORE_AIP_MODE
 
#endif
// __HDI_CORE_FILE_FORMAT__