diff options
Diffstat (limited to 'share/doc/gccint/Files.html')
| -rw-r--r-- | share/doc/gccint/Files.html | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/share/doc/gccint/Files.html b/share/doc/gccint/Files.html new file mode 100644 index 0000000..7ad3227 --- /dev/null +++ b/share/doc/gccint/Files.html @@ -0,0 +1,147 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 1988-2023 Free Software Foundation, Inc. + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with the +Invariant Sections being "Funding Free Software", the Front-Cover +Texts being (a) (see below), and with the Back-Cover Texts being (b) +(see below). A copy of the license is included in the section entitled +"GNU Free Documentation License". + +(a) The FSF's Front-Cover Text is: + +A GNU Manual + +(b) The FSF's Back-Cover Text is: + +You have freedom to copy and modify this GNU Manual, like GNU + software. Copies published by the Free Software Foundation raise + funds for GNU development. --> +<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ --> +<head> +<title>GNU Compiler Collection (GCC) Internals: Files</title> + +<meta name="description" content="GNU Compiler Collection (GCC) Internals: Files"> +<meta name="keywords" content="GNU Compiler Collection (GCC) Internals: Files"> +<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="Option-Index.html#Option-Index" rel="index" title="Option Index"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Type-Information.html#Type-Information" rel="up" title="Type Information"> +<link href="Invoking-the-garbage-collector.html#Invoking-the-garbage-collector" rel="next" title="Invoking the garbage collector"> +<link href="GGC-Roots.html#GGC-Roots" rel="previous" title="GGC Roots"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.indentedblock {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smallindentedblock {margin-left: 3.2em; font-size: smaller} +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" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> +<a name="Files"></a> +<div class="header"> +<p> +Next: <a href="Invoking-the-garbage-collector.html#Invoking-the-garbage-collector" accesskey="n" rel="next">Invoking the garbage collector</a>, Previous: <a href="GGC-Roots.html#GGC-Roots" accesskey="p" rel="previous">GGC Roots</a>, Up: <a href="Type-Information.html#Type-Information" accesskey="u" rel="up">Type Information</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p> +</div> +<hr> +<a name="Source-Files-Containing-Type-Information"></a> +<h3 class="section">23.5 Source Files Containing Type Information</h3> +<a name="index-generated-files"></a> +<a name="index-files_002c-generated"></a> + +<p>Whenever you add <code>GTY</code> markers to a source file that previously +had none, or create a new source file containing <code>GTY</code> markers, +there are three things you need to do: +</p> +<ol> +<li> You need to add the file to the list of source files the type +machinery scans. There are four cases: + +<ol> +<li> For a back-end file, this is usually done +automatically; if not, you should add it to <code>target_gtfiles</code> in +the appropriate port’s entries in <samp>config.gcc</samp>. + +</li><li> For files shared by all front ends, add the filename to the +<code>GTFILES</code> variable in <samp>Makefile.in</samp>. + +</li><li> For files that are part of one front end, add the filename to the +<code>gtfiles</code> variable defined in the appropriate +<samp>config-lang.in</samp>. +Headers should appear before non-headers in this list. + +</li><li> For files that are part of some but not all front ends, add the +filename to the <code>gtfiles</code> variable of <em>all</em> the front ends +that use it. +</li></ol> + +</li><li> If the file was a header file, you’ll need to check that it’s included +in the right place to be visible to the generated files. For a back-end +header file, this should be done automatically. For a front-end header +file, it needs to be included by the same file that includes +<samp>gtype-<var>lang</var>.h</samp>. For other header files, it needs to be +included in <samp>gtype-desc.cc</samp>, which is a generated file, so add it to +<code>ifiles</code> in <code>open_base_file</code> in <samp>gengtype.cc</samp>. + +<p>For source files that aren’t header files, the machinery will generate a +header file that should be included in the source file you just changed. +The file will be called <samp>gt-<var>path</var>.h</samp> where <var>path</var> is the +pathname relative to the <samp>gcc</samp> directory with slashes replaced by +<tt>-</tt>, so for example the header file to be included in +<samp>cp/parser.cc</samp> is called <samp>gt-cp-parser.h</samp>. The +generated header file should be included after everything else in the +source file. +</p> +</li></ol> + +<p>For language frontends, there is another file that needs to be included +somewhere. It will be called <samp>gtype-<var>lang</var>.h</samp>, where +<var>lang</var> is the name of the subdirectory the language is contained in. +</p> +<p>Plugins can add additional root tables. Run the <code>gengtype</code> +utility in plugin mode as <code>gengtype -P pluginout.h <var>source-dir</var> +<var>file-list</var> <var>plugin*.c</var></code> with your plugin files +<var>plugin*.c</var> using <code>GTY</code> to generate the <var>pluginout.h</var> file. +The GCC build tree is needed to be present in that mode. +</p> + +<hr> +<div class="header"> +<p> +Next: <a href="Invoking-the-garbage-collector.html#Invoking-the-garbage-collector" accesskey="n" rel="next">Invoking the garbage collector</a>, Previous: <a href="GGC-Roots.html#GGC-Roots" accesskey="p" rel="previous">GGC Roots</a>, Up: <a href="Type-Information.html#Type-Information" accesskey="u" rel="up">Type Information</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p> +</div> + + + +</body> +</html> |