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_help
#define _H_help
 
/*  FILE: 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
----------------------------------------------------------------------
05-oct-07    abb      Begun
 
*/
 
#include <xmlstring.h>
 
#ifndef _H_ncxconst
#include "ncxconst.h"
#endif
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_typ
#include "typ.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*            C O N S T A N T S              *
*                                   *
*********************************************************************/
 
#define HELP_MODE_BRIEF_MAX            60
#define HELP_MODE_NORMAL_MAX           100
 
 
/********************************************************************
*                                                                   *
*                            T Y P E S                              *
*                                                                   *
*********************************************************************/
 
typedef enum help_mode_t_ {
    HELP_MODE_NONE,   
    HELP_MODE_BRIEF,  
    HELP_MODE_NORMAL, 
    HELP_MODE_FULL    
} help_mode_t;
 
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern void
    help_program_module (const xmlChar *modname,
             const xmlChar *cliname,
             help_mode_t mode);
 
 
extern void
    help_data_module (const ncx_module_t *mod,
              help_mode_t mode);
 
 
extern void
    help_type (const typ_template_t *typ,
           help_mode_t mode);
 
 
extern void
    help_object (obj_template_t *obj,
         help_mode_t mode);
 
 
extern void
    help_write_lines (const xmlChar *str,
              uint32 indent,
              boolean startnl);
 
 
extern void
    help_write_lines_max (const xmlChar *str,
              uint32 indent,
              boolean startnl,
              uint32 maxlen);
 
 
extern help_mode_t
    help_cvt_str (const xmlChar *str);
 
 
extern const xmlChar *
    help_cvt_enum (help_mode_t mode);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_help */