autogen-doc 1:5.18.7-3 / usr / share / doc / autogen-doc / autogen.html / masks.html

This file is indexed.

/usr/share/doc/autogen-doc/autogen.html/masks.html is in autogen-doc 1:5.18.7-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU AutoGen version 5.18, updated December 2015.

Copyright (C) 1992-2015 by Bruce Korb.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. -->
<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU AutoGen - The Automated Program Generator: masks</title>

<meta name="description" content="GNU AutoGen - The Automated Program Generator: masks">
<meta name="keywords" content="GNU AutoGen - The Automated Program Generator: masks">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="AutoOpts.html#AutoOpts" rel="index" title="AutoOpts">
<link href="Function-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Bit-Maps.html#Bit-Maps" rel="up" title="Bit Maps">
<link href="columns-Invocation.html#columns-Invocation" rel="next" title="columns Invocation">
<link href="enum_002dcode.html#enum_002dcode" rel="prev" title="enum-code">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="masks"></a>
<div class="header">
<p>
Previous: <a href="enum_002dcode.html#enum_002dcode" accesskey="p" rel="prev">enum-code</a>, Up: <a href="Bit-Maps.html#Bit-Maps" accesskey="u" rel="up">Bit Maps</a> &nbsp; [<a href="Function-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="AutoOpts.html#AutoOpts" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Bit-Maps-and-Masks"></a>
<h4 class="subsection">8.4.3 Bit Maps and Masks</h4>

<p><samp>str2mask.tpl</samp>
</p>
<p>This template leverages highly off of enumerations (see <a href="enums.html#enums">enums</a>).  It will
produce a header file with bit masks defined for each bit specified with a
<code>cmd</code> attribute.  63 is the highest legal bit number because this
template has not been extended to cope with multiple word masks.  (Patches
would be welcome.)
</p>
<p>There are a few constraints on the names allowed:
</p>
<ul>
<li> names are constrained to alphanumerics and the underscore
</li><li> aliases are not allowed
</li><li> dispatch procedures are not allowed
</li></ul>

<p><code>no-code</code> and <code>no-name</code> are honored.  <code>dispatch</code> is not.  The
lookup function will examine each token in an input string, determine which
bit is specified and add it into a result.  The names may be prefixed with a
hyphen (<tt>-</tt>) or tilde (<tt>~</tt>) to remove the bit(s) from the cumulative
result.  If the string begins with a plus (<tt>+</tt>), hyphen or tilde, a &ldquo;base
value&rdquo; parameter is used for the starting mask, otherwise the conversion
starts with zero.
</p>
<p>Beyond the enumeration attributes that are used (or ignored), the
<samp>str2mask</samp> template accepts a <code>mask</code> attribute.  It takes a few
&ldquo;subattributes&rdquo;:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>m-name</samp>&rsquo;</dt>
<dd><p>a special name for a sub-collection of the mask bits
</p>
</dd>
<dt>&lsquo;<samp>m-bit</samp>&rsquo;</dt>
<dd><p>The name of each previously defined bit(s).  If the desired previously
defined value is a mask, that <code>m-name</code> must be suffixed with &ldquo;<tt>-mask</tt>&rdquo;.
</p>
</dd>
<dt>&lsquo;<samp>m-invert</samp>&rsquo;</dt>
<dd><p>When all done collecting the bits, x-or the value with the mask
of all the bits in the collection.
</p></dd>
</dl>

<p>A mask of all bits in the collection is always generated.
</p>



</body>
</html>

APT Browse - Built by Thomas Orozco.