keymap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, 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_keymap
#define _H_keymap
 
/*  FILE: keymap.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
26-jun-23    abb      Begun
 
*/
 
#include "dlq.h"
#include "obj.h"
#include "status_enum.h"
 
/*** assumes procdefs.h has been included ***/
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* access the cookie in the keymap_map_t struct */
#define KEYMAP_MAP_COOKIE(M) (M)->cookie
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
 
typedef struct keymap_set_t_ {
    obj_template_t *obj;
 
    uint32 anckey_cnt;
 
    dlq_hdr_t cbQ;  // Q of keymap_map_t
 
} keymap_set_t;
 
 
 
typedef struct keymap_map_t_ {
    dlq_hdr_t qhdr;
 
    keymap_set_t *mapset;
 
    void *cookie;
 
    dlq_hdr_t anckeyQ;  // Q of ncx_backptr_t to malloced string
 
    dlq_hdr_t keyQ;  // Q of keymap_key_t
 
} keymap_map_t;
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern keymap_set_t *
    keymap_new_set (obj_template_t *listobj,
                    uint32 anckey_cnt,
                    status_t *res);
 
 
 
extern void
    keymap_free_set (keymap_set_t *mapset);
 
 
 
extern keymap_map_t *
    keymap_new_map (keymap_set_t *mapset,
                    void *cookie,
                    status_t *res,
                    ...);   // ancestor keys
 
 
 
extern void
    keymap_free_map (keymap_set_t *mapset,
                     keymap_map_t *cb);
 
 
extern keymap_map_t *
    keymap_get_map (keymap_set_t *mapset,
                    ...);   // ancestor keys
 
 
 
extern status_t
    keymap_add_row (keymap_map_t *cb,
                    void *cookie,
                    ...);   // list keys
 
 
extern status_t
    keymap_remove_row (keymap_map_t *cb,
                       ...);   // list keys
 
 
extern void
    keymap_dump_map (keymap_map_t *cb);
 
 
 
extern status_t
    keymap_get_return_keys (keymap_map_t *cb,
                            boolean getnext,
                            boolean *islast,
                            void **cookie,
                            dlq_hdr_t *keyQ,
                            ...);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_keymap */