PRM_TemplateBuilder.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        PRM_TemplateBuilder.h (Parameter Library)
 *
 * COMMENTS:
 *      Constructs a PRM_Template * list from an embedded .ds file.
 *
 */

#ifndef __PRM_TemplateBuilder__
#define __PRM_TemplateBuilder__

#include "PRM_API.h"
#include "PRM_Type.h"
#include <UT/UT_NonCopyable.h>
#include <UT/UT_StringHolder.h>

class PRM_Template;
class PRM_ScriptPage;
class DS_Stream;
class UT_IStream;

/// Constructs a PRM_Template list from an embedded .ds file or an istream.
class PRM_API PRM_TemplateBuilder
{
public:
     /// extra_parms is the number of additional parameter templates at the
     /// head of templates(). That is, the first parameter from the .ds file is
     /// loaded into templates()[extra_parms].
     PRM_TemplateBuilder(const UT_StringHolder &name, const char *dstext,
                         const char **cpp_options = nullptr,
                         int extra_parms = 0);
     PRM_TemplateBuilder(const UT_StringHolder &name, UT_IStream &stream,
                         const char **cpp_options = nullptr,
                         int extra_parms = 0);
    ~PRM_TemplateBuilder();

    UT_NON_COPYABLE(PRM_TemplateBuilder)

    PRM_Template        *templates() const      { return myTemplate; }

    int                  templateLength() const { return myTemplateLength; }

    void                 setCallback(const UT_StringRef &name,
                                     PRM_Callback callback);
    void                 setChoiceListPtr(const UT_StringRef &name,
                                          PRM_ChoiceList *list);

    void                 setNoResim(const UT_StringRef &name, bool noresim);
    void                 setNoCook(const UT_StringRef &name, bool nocook);

    /// Returns if it was just built, used for any successive one
    /// time initialization.  Calling this function will mark it as
    /// built.
    bool                justBuilt();

    /// Returns a template pointer by name. Searches nested multiparms.
    PRM_Template        *findTemplate(const UT_StringRef &name);

private:

    void                load(UT_IStream &stream, const char **cpp_options,
                             int extra_parms);

    PRM_Template                *myTemplate;
    int                          myTemplateLength;
    PRM_ScriptPage              *myPage;
    bool                         myJustBuilt;
    UT_StringHolder              myName;
};

#endif