PureDataGraph.h

/* 
 *  MaxGraph
 *  A thin wrapper of the Jamoma Graph system for use in the Cycling '74 Max/MSP environment.
 *  Includes an automated class wrapper to make TTFoundation objects available as objects for Max/MSP.
 *  Copyright © 2010 by Timothy Place
 * 
 * License: This code is licensed under the terms of the "New BSD License"
 * http://creativecommons.org/licenses/BSD/
 */

#ifndef __TT_MAX_GRAPH_H__
#define __TT_MAX_GRAPH_H__

#include "ext.h"                    // Max Header
#include "ext_obex.h"               // Max Object Extensions (attributes) Header
#include "ext_strings.h"            // String Functions
#include "commonsyms.h"             // Common symbols used by the Max 4.5 API
#include "z_dsp.h"                  // MSP Header
#include "jpatcher_api.h"           // Required for patcher traversal code

#include "TTGraphAPI.h"             // Definitions for Jamoma Graph

// TYPE DEFINITIONS

#ifndef SELF
#define SELF ((t_object*)(self))
#endif


typedef TTErr (*TTValidityCheckFunction)(const TTPtr data);     ///< A type that can be used to store a pointer to a validity checking function.

class WrappedClassOptions;

typedef struct _wrappedClass {
    t_class*                maxClass;                           ///< The Max class pointer.
    t_symbol*               maxClassName;                       ///< The name to give the Max class.
    TTSymbol                ttClassName;                        ///< The name of the class as registered with the Jamoma framework.
    TTValidityCheckFunction validityCheck;                      ///< A function to call to validate the context for an object before it is instantiated.
    TTPtr                   validityCheckArgument;              ///< An argument to pass to the validityCheck function when it is called.
    WrappedClassOptions*    options;                            ///< Additional configuration options specified for the class.
    t_hashtab*              maxNamesToTTNames;                  ///< names may not be direct mappings, as we downcase the first letter.
} WrappedClass;



class WrappedClassOptions {
protected:
    TTHash* options;

public:
    WrappedClassOptions()
    {
        options = new TTHash;
    }
    
    virtual ~WrappedClassOptions()
    {
        delete options;
    }
    
    TTErr append(const TTSymbol& optionName, const TTValue& optionValue)
    {
        return options->append(optionName, optionValue);
    }
    
    /** Returns an error if the requested option doesn't exist. */
    TTErr lookup(const TTSymbol& optionName, TTValue& optionValue)
    {
        return options->lookup(optionName, optionValue);
    }
    
};
    

typedef WrappedClass* WrappedClassPtr;                          ///< A pointer to a WrappedClass.
typedef WrappedClassOptions* WrappedClassOptionsPtr;            ///< A pointer to WrappedClassOptions.


// FUNCTIONS

// Wrap a Jamoma Graph class as a Max class.
TTErr wrapAsMaxGraph(TTSymbol& ttClassName, char* maxClassName, WrappedClassPtr* c);

// This version can be passed a method that is called to make sure it is legit to instantiate the class.
TTErr wrapAsMaxGraph(TTSymbol& ttClassName, char* maxClassName, WrappedClassPtr* c, TTValidityCheckFunction validityCheck);

// This version can be passed a method that is called to make sure it is legit to instantiate the class.
TTErr wrapAsMaxGraph(TTSymbol& ttClassName, char* maxClassName, WrappedClassPtr* c, TTValidityCheckFunction validityCheck, TTPtr validityCheckArgument);


// These are versions of the above, but for which additional options can be specified.
TTErr wrapAsMaxGraph(TTSymbol& ttblueClassName, char* maxClassName, WrappedClassPtr* c, WrappedClassOptionsPtr options);
TTErr wrapAsMaxGraph(TTSymbol& ttblueClassName, char* maxClassName, WrappedClassPtr* c, TTValidityCheckFunction validityCheck, WrappedClassOptionsPtr options);
TTErr wrapAsMaxGraph(TTSymbol& ttblueClassName, char* maxClassName, WrappedClassPtr* c, TTValidityCheckFunction validityCheck, TTPtr validityCheckArgument, WrappedClassOptionsPtr options);


TTErr MaxGraphReset(t_object* self);
TTErr MaxGraphSetup(t_object* self);
TTErr MaxGraphConnect(t_object* self, TTGraphObjectBasePtr audioSourceObject, TTUInt16 sourceOutletNumber);
TTErr MaxGraphDrop(t_object* x, long inletNumber, t_object* sourceMaxObject, long sourceOutletNumber);
TTErr MaxGraphObject(t_object* x, TTGraphObjectBasePtr* returnedGraphObject);

#endif // __TT_MAX_GRAPH_H__