/****************************************************************************
** Copyright (C) 2001-2013 RibbonSoft, GmbH. All rights reserved.
**
** This file is part of the dxflib project.
**
** This file 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.
**
** Licensees holding valid dxflib Professional Edition licenses may use 
** this file in accordance with the dxflib Commercial License
** Agreement provided with the Software.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.ribbonsoft.com for further details.
**
** Contact info@ribbonsoft.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/

#ifndef DL_CREATIONINTERFACE_H
#define DL_CREATIONINTERFACE_H

#include "dl_global.h"

#include <string.h>

#include "dl_attributes.h"
#include "dl_codes.h"
#include "dl_entities.h"
#include "dl_extrusion.h"

/**
 * Abstract class (interface) for the creation of new entities.
 * Inherit your class which takes care of the entities in the 
 * processed DXF file from this interface. 
 *
 * Double arrays passed to your implementation contain 3 double 
 * values for x, y, z coordinates unless stated differently.
 *
 * @author Andrew Mustun
 */
class DXFLIB_EXPORT DL_CreationInterface {
public:
    DL_CreationInterface() {
        extrusion = new DL_Extrusion;
    }
    virtual ~DL_CreationInterface() {
        delete extrusion;
    }

    /**
     * Called for every code / value tuple of the DXF file. The complete DXF file
     * contents can be handled by the implemetation of this function.
     */
    virtual void processCodeValuePair(unsigned int groupCode, const std::string& groupValue) = 0;

    /**
     * Called when a section (entity, table entry, etc.) is finished.
     */
    virtual void endSection() = 0;

    /**
     * Called for every layer.
     */
    virtual void addLayer(const DL_LayerData& data) = 0;

    /**
     * Called for every linetype.
     */
    virtual void addLinetype(const DL_LinetypeData& data) = 0;

    /**
      * Called for every dash in linetype pattern
      */
    virtual void addLinetypeDash(double length) = 0;

    /**
     * Called for every block. Note: all entities added after this
     * command go into this block until endBlock() is called.
    *
     * @see endBlock()
     */
    virtual void addBlock(const DL_BlockData& data) = 0;

    /** Called to end the current block */
    virtual void endBlock() = 0;

    /** Called for every text style */
    virtual void addTextStyle(const DL_StyleData& data) = 0;

    /** Called for every point */
    virtual void addPoint(const DL_PointData& data) = 0;

    /** Called for every line */
    virtual void addLine(const DL_LineData& data) = 0;

    /** Called for every xline */
    virtual void addXLine(const DL_XLineData& data) = 0;

    /** Called for every ray */
    virtual void addRay(const DL_RayData& data) = 0;

    /** Called for every arc */
    virtual void addArc(const DL_ArcData& data) = 0;

    /** Called for every circle */
    virtual void addCircle(const DL_CircleData& data) = 0;

    /** Called for every ellipse */
    virtual void addEllipse(const DL_EllipseData& data) = 0;

    /** Called for every polyline start */
    virtual void addPolyline(const DL_PolylineData& data) = 0;

    /** Called for every polyline vertex */
    virtual void addVertex(const DL_VertexData& data) = 0;
    
    /** Called for every spline */
    virtual void addSpline(const DL_SplineData& data) = 0;
    
    /** Called for every spline control point */
    virtual void addControlPoint(const DL_ControlPointData& data) = 0;

    /** Called for every spline fit point */
    virtual void addFitPoint(const DL_FitPointData& data) = 0;
    
    /** Called for every spline knot value */
    virtual void addKnot(const DL_KnotData& data) = 0;

    /** Called for every insert. */
    virtual void addInsert(const DL_InsertData& data) = 0;
    
    /** Called for every trace start */
    virtual void addTrace(const DL_TraceData& data) = 0;
    
    /** Called for every 3dface start */
    virtual void add3dFace(const DL_3dFaceData& data) = 0;

    /** Called for every solid start */
    virtual void addSolid(const DL_SolidData& data) = 0;


    /** Called for every multi Text entity. */
    virtual void addMText(const DL_MTextData& data) = 0;

    /**
     * Called for additional text chunks for MTEXT entities.
     * The chunks come at 250 character in size each. Note that 
     * those chunks come <b>before</b> the actual MTEXT entity.
     */
    virtual void addMTextChunk(const std::string& text) = 0;

    /** Called for every text entity. */
    virtual void addText(const DL_TextData& data) = 0;

    /** Called for every arc aligned text entity. */
    virtual void addArcAlignedText(const DL_ArcAlignedTextData& data) = 0;

    /** Called for every block Attribute entity. */
    virtual void addAttribute(const DL_AttributeData& data) = 0;

    /**
     * Called for every aligned dimension entity. 
     */
    virtual void addDimAlign(const DL_DimensionData& data,
                             const DL_DimAlignedData& edata) = 0;
    /**
     * Called for every linear or rotated dimension entity. 
     */
    virtual void addDimLinear(const DL_DimensionData& data,
                              const DL_DimLinearData& edata) = 0;

    /**
     * Called for every radial dimension entity. 
     */
    virtual void addDimRadial(const DL_DimensionData& data,
                              const DL_DimRadialData& edata) = 0;

    /**
     * Called for every diametric dimension entity. 
     */
    virtual void addDimDiametric(const DL_DimensionData& data,
                              const DL_DimDiametricData& edata) = 0;

    /**
     * Called for every angular dimension (2 lines version) entity. 
     */
    virtual void addDimAngular(const DL_DimensionData& data,
                              const DL_DimAngularData& edata) = 0;

    /**
     * Called for every angular dimension (3 points version) entity. 
     */
    virtual void addDimAngular3P(const DL_DimensionData& data,
                              const DL_DimAngular3PData& edata) = 0;
    
    /**
     * Called for every ordinate dimension entity. 
     */
    virtual void addDimOrdinate(const DL_DimensionData& data,
                             const DL_DimOrdinateData& edata) = 0;
    
    /** 
     * Called for every leader start. 
     */
    virtual void addLeader(const DL_LeaderData& data) = 0;
    
    /** 
     * Called for every leader vertex 
     */
    virtual void addLeaderVertex(const DL_LeaderVertexData& data) = 0;
    
    /** 
     * Called for every hatch entity. 
     */
    virtual void addHatch(const DL_HatchData& data) = 0;
    
    /** 
     * Called for every image entity. 
     */
    virtual void addImage(const DL_ImageData& data) = 0;

    /**
     * Called for every image definition.
     */
    virtual void linkImage(const DL_ImageDefData& data) = 0;

    /** 
     * Called for every hatch loop. 
     */
    virtual void addHatchLoop(const DL_HatchLoopData& data) = 0;

    /** 
     * Called for every hatch edge entity. 
     */
    virtual void addHatchEdge(const DL_HatchEdgeData& data) = 0;

    /**
     * Called for every XRecord with the given handle.
     */
    virtual void addXRecord(const std::string& handle) = 0;

    /**
     * Called for XRecords of type string.
     */
    virtual void addXRecordString(int code, const std::string& value) = 0;

    /**
     * Called for XRecords of type double.
     */
    virtual void addXRecordReal(int code, double value) = 0;

    /**
     * Called for XRecords of type int.
     */
    virtual void addXRecordInt(int code, int value) = 0;

    /**
     * Called for XRecords of type bool.
     */
    virtual void addXRecordBool(int code, bool value) = 0;

    /**
     * Called for every beginning of an XData section of the given application.
     */
    virtual void addXDataApp(const std::string& appId) = 0;

    /**
     * Called for XData tuples.
     */
    virtual void addXDataString(int code, const std::string& value) = 0;

    /**
     * Called for XData tuples.
     */
    virtual void addXDataReal(int code, double value) = 0;

    /**
     * Called for XData tuples.
     */
    virtual void addXDataInt(int code, int value) = 0;

    /**
     * Called for dictionary objects.
     */
    virtual void addDictionary(const DL_DictionaryData& data) = 0;

    /**
     * Called for dictionary entries.
     */
    virtual void addDictionaryEntry(const DL_DictionaryEntryData& data) = 0;

    /** 
     * Called after an entity has been completed.  
     */
    virtual void endEntity() = 0;
    
    /**
     * Called for every comment in the DXF file (code 999).
     */
    virtual void addComment(const std::string& comment) = 0;

    /**
     * Called for every vector variable in the DXF file (e.g. "$EXTMIN").
     */
    virtual void setVariableVector(const std::string& key,  double v1, double v2, double v3, int code) = 0;
    
    /**
     * Called for every string variable in the DXF file (e.g. "$ACADVER").
     */
    virtual void setVariableString(const std::string& key, const std::string& value, int code) = 0;
    
    /**
     * Called for every int variable in the DXF file (e.g. "$ACADMAINTVER").
     */
    virtual void setVariableInt(const std::string& key, int value, int code) = 0;
    
    /**
     * Called for every double variable in the DXF file (e.g. "$DIMEXO").
     */
    virtual void setVariableDouble(const std::string& key, double value, int code) = 0;

#ifdef DL_COMPAT
    virtual void setVariableVector(const char* key,  double v1, double v2, double v3, int code) = 0;
    virtual void setVariableString(const char* key, const char* value, int code) = 0;
    virtual void setVariableInt(const char* key, int value, int code) = 0;
    virtual void setVariableDouble(const char* key, double value, int code) = 0;
    virtual void processCodeValuePair(unsigned int groupCode, char* groupValue) = 0;
    virtual void addComment(const char* comment) = 0;
    virtual void addMTextChunk(const char* text) = 0;
#endif
    
     /**
      * Called when a SEQEND occurs (when a POLYLINE or ATTRIB is done)
      */
    virtual void endSequence() = 0;

    /** Sets the current attributes for entities. */
    void setAttributes(const DL_Attributes& attrib) {
        attributes = attrib;
    }

    /** @return the current attributes used for new entities. */
    DL_Attributes getAttributes() {
        return attributes;
    }

    /** Sets the current attributes for entities. */
    void setExtrusion(double dx, double dy, double dz, double elevation) {
        extrusion->setDirection(dx, dy, dz);
        extrusion->setElevation(elevation);
    }

    /** @return the current attributes used for new entities. */
    DL_Extrusion* getExtrusion() {
        return extrusion;
    }

protected:
    DL_Attributes attributes;
    DL_Extrusion *extrusion;
};

#endif
