soarapi_datatypes.h

Go to the documentation of this file.

#ifndef _SOARAPI_DATATYPES_H_   /* excludeFromBuildInfo */
#define _SOARAPI_DATATYPES_H_

#include "soarkernel.h"
#include "sysdep.h"
#include <stdarg.h>

#define SOARRESULT_RESULT_LENGTH 256

typedef struct soarResult_struct {

    char result[SOARRESULT_RESULT_LENGTH];
    int resultLength;

} soarResult;

#define init_soarResult(r) { \
 (r).resultLength = SOARRESULT_RESULT_LENGTH; \
 (*((r).result)) = '\0'; \
}

#define clearSoarResultResult(r) (*((r)->result)) = '\0';

#define setSoarResultResultStdError(r) {strncpy( ((r)->result),  "Error", SOARRESULT_RESULT_LENGTH); (r)->result[SOARRESULT_RESULT_LENGTH-1]=0;}

#ifdef USE_STDARGS
extern void setSoarResultResult(soarResult * res, const char *format, ...);
#else
extern void setSoarResultResult();
#endif

#ifdef USE_STDARGS
extern void appendSoarResultResult(soarResult * res, const char *format, ...);
#else
extern void appendSoarResultResult();
#endif

#ifdef USE_STDARGS
extern void appendSymbolsToSoarResultResult(soarResult * res, const char *format, ...);
#else
extern void appendSymbolsToSoarResultResult();
#endif

typedef void *psoar_agent;

typedef void *psoar_wme;

/*
 * NOTE Documenting this struct seems to result in a who code section
 *  being generated... :(
 */

typedef struct soar_apiAgentIter_struct {

    cons *_begin;  
    cons *_current;
    bool more;     
} soar_apiAgentIterator;

enum soar_apiResult {
    SOAR_OK,
    SOAR_ERROR
};

/*
 * \brief  A production type
 *
 */
enum soar_apiProductionType {
    CHUNKS,
    DEFAULT,
    TASK,
    USER,
    ALL
};

/*
 * \brief  The agent's learning setting
 *
 */
enum soar_apiLearningSetting {
    ON,
    OFF,
    EXCEPT,
    ONLY,
    ALL_LEVELS,
    BOTTOM_UP
};

/*
 * \brief  The slot type
 *
 */
enum soar_apiSlotType {
    NO_SLOT,
    STATE_SLOT,
    OPERATOR_SLOT,
    SUPERSTATE_SLOT,
    SUPEROPERATOR_SLOT,
    SUPERSUPERSTATE_SLOT,
    SUPERSUPEROPERATOR_SLOT
};

typedef struct ask_cb_data_st {

    preference **selection;
    preference *candidates;

} soar_apiAskCallbackData;

typedef struct sapiwme_st {
    const char *id;
    const char *attr;
    const char *value;
    long timetag;
} soarapi_wme;

/*
 * \brief The interrupt setting
 *
 */
enum soar_apiInterruptSetting {
    INTERRUPT_OFF,
    INTERRUPT_ON,
    INTERRUPT_PRINT
};

#endif

---