obj_help.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_obj_help
#define _H_obj_help
 
/*  FILE: obj_help.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
17-aug-08    abb      Begun; split from obj.h to prevent H file loop
 
*/
 
 
#ifndef _H_dlq
#include "dlq.h"
#endif
 
#ifndef _H_help
#include "help.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
/* group defined in help.h */
extern void
    obj_dump_template (obj_template_t *obj,
               help_mode_t mode,
               uint32 nestlevel,
               uint32 indent);
 
 
extern void
    obj_dump_template_ex (obj_template_t *obj,
                          help_mode_t mode,
                          uint32 nestlevel,
                          uint32 indent,
                          boolean with_desc);
 
 
extern void
    obj_dump_datadefQ (dlq_hdr_t *datadefQ,
               help_mode_t mode,
               uint32 nestlevel,
               uint32 indent);
 
 
extern status_t
    obj_dump_template_buff (obj_template_t *obj,
                            xmlChar *buff,
                            uint32 bufflen);
 
 
extern const xmlChar *
    obj_help_description (const obj_template_t *obj);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_obj_help */