1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/**
* @namespace biew
* @file biewhelp.h
* @brief This file contains prototypes of BIEW help system.
* @version -
* @remark this source file is part of Binary vIEW project (BIEW).
* The Binary vIEW (BIEW) is copyright (C) 1995 Nick Kurshev.
* All rights reserved. This software is redistributable under the
* licence given in the file "Licence.en" ("Licence.ru" in russian
* translation) distributed in the BIEW archive.
* @note Requires POSIX compatible development system
*
* @author Nick Kurshev
* @since 1999
* @note Development, fixes and improvements
**/
#ifndef __BIEWHELP__H
#define __BIEWHELP__H
#ifdef __cplusplus
extern "C" {
#endif
#ifndef __TWIN_H
#include "biewlib/twin.h"
#endif
#define BIEW_HELP_VER "BIEW_HLP v5.2.0"
#define HLP_SLONG_LEN 9
#define HLP_VER_LEN 16
/** Maximal size of help topic - is 0xFFFF bytes */
typedef struct tag_biew_help_item
{
char item_id[HLP_SLONG_LEN]; /**< character representation of short type. Null-terminated */
char item_off[HLP_SLONG_LEN];
char item_length[HLP_SLONG_LEN];
char item_decomp_size[HLP_SLONG_LEN];
}BIEW_HELP_ITEM;
typedef struct tag_biew_help
{
char help_version[HLP_VER_LEN]; /**< identifiaction signature */
char item_count[HLP_SLONG_LEN]; /**< total count of items */
BIEW_HELP_ITEM items[1]; /**< Array of items */
/**< Binary data of help */
}BIEW_HELP;
/** Color definition */
#define HLPC_BOLD_ON 0x01
#define HLPC_ITALIC_ON 0x02
#define HLPC_UNDERLINE_ON 0x03
#define HLPC_STRIKETHROUGH_ON 0x04
#define HLPC_REVERSE_ON 0x05
#define HLPC_LINK_ON 0x06
#define HLPC_BOLD_OFF 0x11
#define HLPC_ITALIC_OFF 0x12
#define HLPC_UNDERLINE_OFF 0x13
#define HLPC_STRIKETHROUGH_OFF 0x14
#define HLPC_REVERSE_OFF 0x15
#define HLPC_LINK_OFF 0x16
extern tBool __FASTCALL__ hlpOpen( tBool interactive );
extern void __FASTCALL__ hlpClose( void );
/** Return uncompressed size of help item
0 - if error occured */
extern unsigned long __FASTCALL__ hlpGetItemSize(unsigned long item_id);
extern tBool __FASTCALL__ hlpLoadItem(unsigned long item_id, void __HUGE__* buffer);
/** Fully-functionallity utility for displaying help */
extern void __FASTCALL__ hlpDisplay(unsigned long id);
/** Returns array of char pointers.
Title always is data[0] */
extern char ** __FASTCALL__ hlpPointStrings(char *data,unsigned long data_size,
unsigned long *nstr);
/** Filles buffer as video memory from string */
extern unsigned __FASTCALL__ hlpFillBuffer(tvioBuff * dest,unsigned int cw_dest,
const char * str,unsigned int cb_str,
unsigned int shift,unsigned *n_tabs,
tBool is_hl);
/** Paints line of help */
extern void __FASTCALL__ hlpPaintLine(TWindow *win,unsigned y,const char *str,
tBool is_hl);
#ifdef __cplusplus
}
#endif
#endif
|
