view anagram/guisupport/help.h @ 21:1c9dac05d040

Add lint-style FALLTHROUGH annotations to fallthrough cases. (in the parse engine and thus the output code) Document this, because the old output causes warnings with gcc10.
author David A. Holland
date Mon, 13 Jun 2022 00:04:38 -0400
parents 13d2b8934445
children
line wrap: on
line source

/*
 * AnaGram, A System for Syntax Directed Programming
 * Copyright 2006 David A. Holland. All Rights Reserved.
 * See the file COPYING for license and usage terms.
 *
 * help.h - help data.
 */

#ifndef HELP_H
#define HELP_H

struct HelpTopic; // Opaque.

void help_init(void);

const char *helptopic_gettitle(const HelpTopic *ht);
const char *helptopic_gettext(const HelpTopic *ht);

const HelpTopic *help_topic(const char *topic);
int help_topicexists(const char *topic);

// helpindex_get returns the topic name for help topic 0..helpindex_num-1.
// This list does *not* include the magic help topic that used to be
// internally numbered 0.
unsigned      helpindex_num(void);
const char   *helpindex_get(unsigned which);

#endif /* HELP_H */