From: kristaps@mdocml.bsd.lv
To: source@mdocml.bsd.lv
Subject: mdocml: Move register information into mandoc.h, which is where it
Date: Mon, 5 Jul 2010 16:10:22 -0400 (EDT) [thread overview]
Message-ID: <201007052010.o65KAM1n013743@krisdoz.my.domain> (raw)
Log Message:
-----------
Move register information into mandoc.h, which is where it should have
been in the first place (mandoc.h contains system-wide declarations).
Modified Files:
--------------
mdocml:
mandoc.h
regs.h
Revision Data
-------------
Index: regs.h
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/regs.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -Lregs.h -Lregs.h -u -p -r1.5 -r1.6
--- regs.h
+++ regs.h
@@ -20,28 +20,6 @@
__BEGIN_DECLS
-enum regs {
- REG_nS = 0, /* nS */
- REG__MAX
-};
-
-struct reg {
- int set; /* whether set or not */
- union {
- unsigned u; /* unsigned integer */
- } v;
-};
-
-/*
- * Registers are non-scoped state. These can be manipulated directly in
- * libroff or indirectly in libman or libmdoc by macros. These should
- * be implemented sparingly (we are NOT roffdoc!) and documented fully
- * in roff.7.
- */
-struct regset {
- struct reg regs[REG__MAX];
-};
-
char *roff_setstr(const char *, const char *);
char *roff_getstr(const char *);
char *roff_getstrn(const char *, size_t);
Index: mandoc.h
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandoc.h,v
retrieving revision 1.15
retrieving revision 1.16
diff -Lmandoc.h -Lmandoc.h -u -p -r1.15 -r1.16
--- mandoc.h
+++ mandoc.h
@@ -17,10 +17,13 @@
#ifndef MANDOC_H
#define MANDOC_H
+/*
+ * This contains declarations that are available system-wide.
+ */
+
#define ASCII_NBRSP 31 /* non-breaking space */
#define ASCII_HYPH 30 /* breakable hyphen */
-
__BEGIN_DECLS
enum mandocerr {
@@ -106,8 +109,39 @@ enum mandocerr {
MANDOCERR_MAX
};
-typedef int (*mandocmsg)(enum mandocerr,
- void *, int, int, const char *);
+enum regs {
+ REG_nS = 0, /* register: nS */
+ REG__MAX
+};
+
+/*
+ * A single register entity. If "set" is zero, the value of the
+ * register should be the default one, which is per-register. It's
+ * assumed that callers know which type in "v" corresponds to which
+ * register value.
+ */
+struct reg {
+ int set; /* whether set or not */
+ union {
+ unsigned u; /* unsigned integer */
+ } v;
+};
+
+/*
+ * The primary interface to setting register values is in libroff,
+ * although libmdoc and libman from time to time will manipulate
+ * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
+ */
+struct regset {
+ struct reg regs[REG__MAX];
+};
+
+/*
+ * Callback function for warnings, errors, and fatal errors as they
+ * occur in the compilers libroff, libmdoc, and libman.
+ */
+typedef int (*mandocmsg)(enum mandocerr, void *,
+ int, int, const char *);
__END_DECLS
--
To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv
reply other threads:[~2010-07-05 20:10 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=201007052010.o65KAM1n013743@krisdoz.my.domain \
--to=kristaps@mdocml.bsd.lv \
--cc=source@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).