grp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_grp
#define _H_grp

/*  FILE: grp.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/

/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************

date         init     comment
----------------------------------------------------------------------
09-dec-07    abb      Begun

*/

#include <xmlstring.h>
#include <xmlregexp.h>

#ifndef _H_ncxconst
#include "ncxconst.h"
#endif

#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif

#ifndef _H_status
#include "status.h"
#endif

#ifndef _H_tk
#include "tk.h"
#endif

#ifndef _H_xmlns
#include "xmlns.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/


/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/

typedef struct grp_template_t_ {
    dlq_hdr_t        qhdr;       
    xmlChar         *name;       
    xmlChar         *descr;      
    xmlChar         *ref;        
    ncx_error_t      tkerr;      
    void            *parent;     
    struct grp_template_t_ *parentgrp;    
    xmlns_id_t       nsid;       
    boolean          used;       
    boolean          istop;      
    boolean          expand_done;  
    boolean          loop_detected;  
    ncx_status_t     status;        
    uint32           grpindex;         
    dlq_hdr_t        typedefQ;             
    dlq_hdr_t        groupingQ;            
    dlq_hdr_t        datadefQ;             
    dlq_hdr_t        appinfoQ;              
} grp_template_t;



/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/


extern grp_template_t *
    grp_new_template (void);


extern void
    grp_free_template (grp_template_t *grp);


extern void
    grp_clean_groupingQ (dlq_hdr_t *que);


extern boolean
    grp_has_typedefs (const grp_template_t *grp);


extern const xmlChar *
    grp_get_mod_name (const grp_template_t *grp);


#ifdef __cplusplus
}  /* end extern 'C' */
#endif

#endif      /* _H_grp */