Merge branch 'master' of ssh://crater.dragonflybsd.org/repository/git/dragonfly
[dragonfly.git] / contrib / gcc-3.4 / gcc / mkdeps.h
CommitLineData
003757ed
MD
1/* Dependency generator for Makefile fragments.
2 Copyright (C) 2000, 2001, 2003 Free Software Foundation, Inc.
3 Contributed by Zack Weinberg, Mar 2000
4
5This program is free software; you can redistribute it and/or modify it
6under the terms of the GNU General Public License as published by the
7Free Software Foundation; either version 2, or (at your option) any
8later version.
9
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
16along with this program; if not, write to the Free Software
17Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18
19 In other words, you are welcome to use, share and improve this program.
20 You are forbidden to forbid anyone else to use, share and improve
21 what you give them. Help stamp out software-hoarding! */
22
23#ifndef GCC_MKDEPS_H
24#define GCC_MKDEPS_H
25
26/* This is the data structure used by all the functions in mkdeps.c.
27 It's quite straightforward, but should be treated as opaque. */
28
29struct deps;
30
31/* Create a deps buffer. */
32extern struct deps *deps_init (void);
33
34/* Destroy a deps buffer. */
35extern void deps_free (struct deps *);
36
37/* Add a target (appears on left side of the colon) to the deps list. Takes
38 a boolean indicating whether to quote the target for MAKE. */
39extern void deps_add_target (struct deps *, const char *, int);
40
41/* Sets the default target if none has been given already. An empty
42 string as the default target is interpreted as stdin. */
43extern void deps_add_default_target (struct deps *, const char *);
44
45/* Add a dependency (appears on the right side of the colon) to the
46 deps list. Dependencies will be printed in the order that they
47 were entered with this function. By convention, the first
48 dependency entered should be the primary source file. */
49extern void deps_add_dep (struct deps *, const char *);
50
51/* Write out a deps buffer to a specified file. The third argument
52 is the number of columns to word-wrap at (0 means don't wrap). */
53extern void deps_write (const struct deps *, FILE *, unsigned int);
54
55/* Write out a deps buffer to a file, in a form that can be read back
56 with deps_restore. Returns nonzero on error, in which case the
57 error number will be in errno. */
58extern int deps_save (struct deps *, FILE *);
59
60/* Read back dependency information written with deps_save into
61 the deps buffer. The third argument may be NULL, in which case
62 the dependency information is just skipped, or it may be a filename,
63 in which case that filename is skipped. */
64extern int deps_restore (struct deps *, FILE *, const char *);
65
66/* For each dependency *except the first*, emit a dummy rule for that
67 file, causing it to depend on nothing. This is used to work around
68 the intermediate-file deletion misfeature in Make, in some
69 automatic dependency schemes. */
70extern void deps_phony_targets (const struct deps *, FILE *);
71
72#endif /* ! GCC_MKDEPS_H */