trselect.h

/* trselect.h */
/* $Id: trselect.h,v 1.6 2003/02/19 14:39:49 ibadm Exp $ */
#ifndef __trselect_h
#define __trselect_h

/***********************************************************************
 *
 *            Tools to 'select' traces in SQL-like manner.
 *
 ***********************************************************************/

#include <stdarg.h>
#include <mix/trset.h>
#include <mix/vsp_trace.h>
#include <mix/ErrCodes.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

  /*
   *   DATA TYPES AND DEFINITIONS
   */

  typedef enum
  {
    TsMopEQ,        
    TsMopNE,        
    TsMopMultiEQ,   
    TsMopGT,        
    TsMopLT,        
    TsMopRANGE,     
    __TsMopNumber__

  } TsMatchOp;

  typedef enum
  {
    TsVaUnique = (int)__TsMopNumber__,  
    TsVaAscentOrder,        
    TsVaDescentOrder,       
#if 0
    TsVaMopGE,          /* greater or equal to <arg> */
    TsVaMopLE,          /* less or equal to <arg> */
#endif
    TsVaEnd = (-1)      
  } TsVarArgOp;

  typedef union
  {
    Int4        i;
    Real4       r;
    Char        c;
    Int4        *pi;
    Real4       *pr;
    Char        *pc;

  } TsMatchArg;

  typedef struct
  {
    TraceAttrId taid;       /* name of trace header field */
    TsMatchOp   mop;        /* matching operation */
    TsMatchArg  marg;       /* matching argument */
    unsigned    arg_dim;    /* argument's dimension for TsMopMultiEQ */

  } TsInclRule;

  typedef struct
  {
    TraceAttrId taid;       /* name of trace header field */

  } TsUniqRule;

  typedef struct
  {
    TraceAttrId taid;
    Compar  order;

  } TsSortRule;

  typedef struct
  {
    unsigned    incl_rules_n;
    TsInclRule  *incl_rules;

    unsigned    uniq_rules_n;
    TsUniqRule  *uniq_rules;

    unsigned    sort_rules_n;
    TsSortRule  *sort_rules;

  } TsExpr;


  typedef struct
  {
    unsigned    fetch_rules_n;
    TsSortRule  *fetch_rules;

    void    *map_rules2index;

  } TsFetcher;


#define TsMargStdSize           20

#define TsDefaultMatchingPrecision  0.001


  /*
   *   PROCEDURES
   */

  ErrCode   TsSelect (TrSet* ts, TrIndexTable* it, const TsExpr* expr);

  ErrCode   TsVaSelect (TrSet* ts, TrIndexTable* it, ...);

  ErrCode   TsBuildExpr (TsExpr* expr, va_list val);

  ErrCode   TsExprToString (const TsExpr* expr, char** str);

  ErrCode   TsStringToExpr (const char* str, TsExpr* expr);

  char*     TsExplainExpr (const TsExpr* expr);

  ErrCode   TsInvertIndexTable (TrSet* ts, const TrIndexTable* dit,
                    TrIndexTable* rit);

  Logic*    TsPresenceTable (TrSet* ts, const TrIndexTable* it);

  void      TsFreeExpr (TsExpr* expr);

  /*
   *   SERVICE PROCEDURES
   */

  Logic     Ts_MatchTrace (TrHeader* pHdr,
                   unsigned rules_n,
                   const TsInclRule* rules);

  Compar    Ts_CompareTracesByRules (TrHeader* pHdr1,
                     TrHeader* pHdr2,
                     unsigned rules_n,
                     const TsSortRule* rules);

  /*
   *   DATA
   */

#ifndef __trselect_vars

  extern Real4  TsMatchingPrecision;

#endif /* __trselect_vars */


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* trselect.h */