← Back to branch summary

~ubuntu-branches/ubuntu/utopic/critcl/utopic

« back to all changes in this revision

Viewing changes to embedded/www/files/critcl_util.html

  • Committer: Package Import Robot
  • Author(s): Andrew Shadura
  • Date: 2013-05-11 00:08:06 UTC
  • Revision ID: package-import@ubuntu.com-20130511000806-7hq1zc3fnn0gat79
Tags: upstream-3.1.9
Import upstream version 3.1.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
embedded/www/files/critcl_util.html
 
1
 
 
2
<html><head>
 
3
<title>critcl::util - C Runtime In Tcl (CriTcl)</title>
 
4
<style type="text/css"><!--
 
5
    HTML {
 
6
        background:     #FFFFFF;
 
7
        color:          black;
 
8
    }
 
9
    BODY {
 
10
        background:     #FFFFFF;
 
11
        color:          black;
 
12
    }
 
13
    DIV.doctools {
 
14
        margin-left:    10%;
 
15
        margin-right:   10%;
 
16
    }
 
17
    DIV.doctools H1,DIV.doctools H2 {
 
18
        margin-left:    -5%;
 
19
    }
 
20
    H1, H2, H3, H4 {
 
21
        margin-top:     1em;
 
22
        font-family:    sans-serif;
 
23
        font-size:      large;
 
24
        color:          #005A9C;
 
25
        background:     transparent;
 
26
        text-align:             left;
 
27
    }
 
28
    H1.title {
 
29
        text-align: center;
 
30
    }
 
31
    UL,OL {
 
32
        margin-right: 0em;
 
33
        margin-top: 3pt;
 
34
        margin-bottom: 3pt;
 
35
    }
 
36
    UL LI {
 
37
        list-style: disc;
 
38
    }
 
39
    OL LI {
 
40
        list-style: decimal;
 
41
    }
 
42
    DT {
 
43
        padding-top:    1ex;
 
44
    }
 
45
    UL.toc,UL.toc UL, UL.toc UL UL {
 
46
        font:           normal 12pt/14pt sans-serif;
 
47
        list-style:     none;
 
48
    }
 
49
    LI.section, LI.subsection {
 
50
        list-style:     none;
 
51
        margin-left:    0em;
 
52
        text-indent:    0em;
 
53
        padding:        0em;
 
54
    }
 
55
    PRE {
 
56
        display:        block;
 
57
        font-family:    monospace;
 
58
        white-space:    pre;
 
59
        margin:         0%;
 
60
        padding-top:    0.5ex;
 
61
        padding-bottom: 0.5ex;
 
62
        padding-left:   1ex;
 
63
        padding-right:  1ex;
 
64
        width:          100%;
 
65
    }
 
66
    PRE.example {
 
67
        color:          black;
 
68
        background:     #f5dcb3;
 
69
        border:         1px solid black;
 
70
    }
 
71
    UL.requirements LI, UL.syntax LI {
 
72
        list-style:     none;
 
73
        margin-left:    0em;
 
74
        text-indent:    0em;
 
75
        padding:        0em;
 
76
    }
 
77
    DIV.synopsis {
 
78
        color:          black;
 
79
        background:     #80ffff;
 
80
        border:         1px solid black;
 
81
        font-family:    serif;
 
82
        margin-top:     1em;
 
83
        margin-bottom:  1em;
 
84
    }
 
85
    UL.syntax {
 
86
        margin-top:     1em;
 
87
        border-top:     1px solid black;
 
88
    }
 
89
    UL.requirements {
 
90
        margin-bottom:  1em;
 
91
        border-bottom:  1px solid black;
 
92
    }
 
93
--></style>
 
94
</head>
 
95
<! -- Generated from file '/home/aku/Projects/Packages/Critcl/dev-master/embedded/www/files/critcl_util.html' by tcllib/doctools with format 'html'
 
96
   -->
 
97
<! -- Copyright &copy; 2011-2012 Andreas Kupries
 
98
   -->
 
99
<! -- CVS: $Id$ critcl::util.n
 
100
   -->
 
101
<body><div class="doctools">
 
102
<hr> [
 
103
  <a href="../toc.html">Table Of Contents</a>
 
104
| <a href="../index.html">Keyword Index</a>
 
105
] <hr>
 
106
<h1 class="title">critcl::util(n) 1 doc &quot;C Runtime In Tcl (CriTcl)&quot;</h1>
 
107
<div id="name" class="section"><h2><a name="name">Name</a></h2>
 
108
<p>critcl::util - CriTcl Utilities</p>
 
109
</div>
 
110
<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
 
111
<ul class="toc">
 
112
<li class="section"><a href="#toc">Table Of Contents</a></li>
 
113
<li class="section"><a href="#synopsis">Synopsis</a></li>
 
114
<li class="section"><a href="#section1">Description</a></li>
 
115
<li class="section"><a href="#section2">API</a></li>
 
116
<li class="section"><a href="#section3">Authors</a></li>
 
117
<li class="section"><a href="#section4">Bugs, Ideas, Feedback</a></li>
 
118
<li class="section"><a href="#keywords">Keywords</a></li>
 
119
<li class="section"><a href="#category">Category</a></li>
 
120
<li class="section"><a href="#copyright">Copyright</a></li>
 
121
</ul>
 
122
</div>
 
123
<div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2>
 
124
<div class="synopsis">
 
125
<ul class="requirements">
 
126
<li>package require <b class="pkgname">Tcl 8.4</b></li>
 
127
<li>package require <b class="pkgname">critcl <span class="opt">?2.1?</span></b></li>
 
128
<li>package require <b class="pkgname">critcl::util <span class="opt">?1?</span></b></li>
 
129
</ul>
 
130
<ul class="syntax">
 
131
<li><a href="#1"><b class="cmd">::critcl::util::checkfun</b> <i class="arg">name</i> <span class="opt">?<i class="arg">label</i>?</span></a></li>
 
132
</ul>
 
133
</div>
 
134
</div>
 
135
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
 
136
<p>Welcome to the <i class="term">C Runtime In Tcl</i>, <i class="term"><a href="critcl_pkg.html">CriTcl</a></i> for short, a
 
137
system to build C extension packages for Tcl on the fly, from C code
 
138
embedded within Tcl scripts, for all who wish to make their code go
 
139
faster.</p>
 
140
<p>This document is the reference manpage for the <b class="package">critcl::util</b>
 
141
package. This package provides convenience commands for advanced
 
142
functionality built on top of the core.
 
143
Its intended audience are mainly developers wishing to write Tcl
 
144
packages with embedded C code.</p>
 
145
<p>This package resides in the Core Package Layer of CriTcl.</p>
 
146
<p><img alt="arch_core" src="../image/arch_core.png"></p>
 
147
</div>
 
148
<div id="section2" class="section"><h2><a name="section2">API</a></h2>
 
149
<dl class="definitions">
 
150
<dt><a name="1"><b class="cmd">::critcl::util::checkfun</b> <i class="arg">name</i> <span class="opt">?<i class="arg">label</i>?</span></a></dt>
 
151
<dd><p>This command checks the build-time environment for the existence of
 
152
the C function <i class="arg">name</i>.
 
153
It returns <b class="const">true</b> on success, and <b class="const">false</b> otherwise.</p></dd>
 
154
</dl>
 
155
</div>
 
156
<div id="section3" class="section"><h2><a name="section3">Authors</a></h2>
 
157
<p>Andreas Kupries</p>
 
158
</div>
 
159
<div id="section4" class="section"><h2><a name="section4">Bugs, Ideas, Feedback</a></h2>
 
160
<p>This document, and the package it describes, will undoubtedly contain
 
161
bugs and other problems.
 
162
Please report such at <a href="https://github.com/andreas-kupries/critcl">https://github.com/andreas-kupries/critcl</a>.
 
163
Please also report any ideas for enhancements you may have for either
 
164
package and/or documentation.</p>
 
165
</div>
 
166
<div id="keywords" class="section"><h2><a name="keywords">Keywords</a></h2>
 
167
<p><a href="../index.html#key8">C code</a>, <a href="../index.html#key3">Embedded C Code</a>, <a href="../index.html#key6">code generator</a>, <a href="../index.html#key0">compile &amp; run</a>, <a href="../index.html#key10">compiler</a>, <a href="../index.html#key1">dynamic code generation</a>, <a href="../index.html#key2">dynamic compilation</a>, <a href="../index.html#key9">generate package</a>, <a href="../index.html#key4">linker</a>, <a href="../index.html#key5">on demand compilation</a>, <a href="../index.html#key7">on-the-fly compilation</a></p>
 
168
</div>
 
169
<div id="category" class="section"><h2><a name="category">Category</a></h2>
 
170
<p>Glueing/Embedded C code</p>
 
171
</div>
 
172
<div id="copyright" class="section"><h2><a name="copyright">Copyright</a></h2>
 
173
<p>Copyright &copy; 2011-2012 Andreas Kupries</p>
 
174
</div>
 
175
</div></body></html>