view anagram/guisupport/help.h @ 8:ec2b657edf13

Add explicit lint-comment-style fallthrough annotations. GCC now assumes that if you don't have these you're making a mistake, which is annoying. XXX: This changeset updates the AG output files only (by hand) and is XXX: abusive - rebuilding them will erase the change. However, I need XXX: to get things to build before I can try to get AG to issue the XXX: annotations itself, so this seems like a reasonable expedient.
author David A. Holland
date Mon, 30 May 2022 23:51:43 -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 */