[deliverable/binutils-gdb.git] / ld / deffile.h

/* deffile.h - header for .DEF file parser
   Copyright (C) 1998-2020 Free Software Foundation, Inc.
   Written by DJ Delorie dj@cygnus.com

   This file is part of the GNU Binutils.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3, or (at your option)
   any later version.

   The program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with GLD; see the file COPYING.  If not, write to the Free
   Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
   02110-1301, USA.  */

#ifndef DEFFILE_H
#define DEFFILE_H

/* DEF storage definitions.  Note that any ordinal may be zero, and
   any pointer may be NULL, if not defined by the DEF file.  */

typedef struct def_file_section {
  char *name;			/* always set */
  char *class;			/* may be NULL */
  char flag_read, flag_write, flag_execute, flag_shared;
} def_file_section;

typedef struct def_file_export {
  char *name;			/* always set */
  char *internal_name;		/* always set, may == name */
  char *its_name;		/* optional export table name referred to. */
  int ordinal;			/* -1 if not specified */
  int hint;
  char flag_private, flag_constant, flag_noname, flag_data, flag_forward;
} def_file_export;

typedef struct def_file_module {
  struct def_file_module *next;
  void *user_data;
  char name[1];			/* extended via malloc */
} def_file_module;

typedef struct def_file_import {
  char *internal_name;		/* always set */
  def_file_module *module;	/* always set */
  char *name;			/* may be NULL; either this or ordinal will be set */
  char *its_name;		/* optional import table name referred to. */
  int ordinal;			/* may be -1 */
  int data;			/* = 1 if data */
} def_file_import;

typedef struct def_file_aligncomm {
  struct def_file_aligncomm *next;	/* Chain pointer.  */
  char *symbol_name;		/* Name of common symbol.  */
  unsigned int alignment;	/* log-2 alignment.        */
} def_file_aligncomm;

typedef struct def_file {
  /* From the NAME or LIBRARY command.  */
  char *name;
  int is_dll;			/* -1 if NAME/LIBRARY not given */
  bfd_vma base_address;		/* (bfd_vma)(-1) if unspecified */

  /* From the DESCRIPTION command.  */
  char *description;

  /* From the STACK/HEAP command, -1 if unspecified.  */
  int stack_reserve, stack_commit;
  int heap_reserve, heap_commit;

  /* From the SECTION/SEGMENT commands.  */
  int num_section_defs;
  def_file_section *section_defs;

  /* From the EXPORTS commands.  */
  int num_exports;
  def_file_export *exports;

  /* Used by imports for module names.  */
  def_file_module *modules;

  /* From the IMPORTS commands.  */
  int num_imports;
  def_file_import *imports;

  /* From the VERSION command, -1 if not specified.  */
  int version_major, version_minor;

  /* Only expected from .drectve sections, not .DEF files.  */
  def_file_aligncomm *aligncomms;

} def_file;

extern def_file *def_file_empty (void);

/* The second arg may be NULL.  If not, this .def is appended to it.  */
extern def_file *def_file_parse (const char *, def_file *);
extern void def_file_free (def_file *);
extern def_file_export *def_file_add_export (def_file *, const char *,
					     const char *, int,
					     const char *, int *);
extern def_file_import *def_file_add_import (def_file *, const char *,
					     const char *, int, const char *,
					     const char *, int *);
extern int def_file_add_import_from (def_file *fdef,
				     int num_imports,
				     const char *name,
				     const char *module,
				     int ordinal,
				     const char *internal_name,
				     const char *its_name);
extern def_file_import *def_file_add_import_at (def_file *, int, const char *,
						const char *, int, const char *,
					        const char *);
extern void def_file_add_directive (def_file *, const char *, int);
extern def_file_module *def_get_module (def_file *, const char *);
#ifdef DEF_FILE_PRINT
extern void def_file_print (FILE *, def_file *);
#endif

#endif /* DEFFILE_H */
Commit	Line	Data
252b5132	1	/* deffile.h - header for .DEF file parser
b3adc24a	2	Copyright (C) 1998-2020 Free Software Foundation, Inc.
252b5132 RH	3	Written by DJ Delorie dj@cygnus.com
252b5132 RH	4
f96b4a7b	5	This file is part of the GNU Binutils.
252b5132	6
f96b4a7b	7	This program is free software; you can redistribute it and/or modify
252b5132	8	it under the terms of the GNU General Public License as published by
f96b4a7b	9	the Free Software Foundation; either version 3, or (at your option)
252b5132 RH	10	any later version.
252b5132 RH	11
f96b4a7b	12	The program is distributed in the hope that it will be useful,
252b5132 RH	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with GLD; see the file COPYING. If not, write to the Free
75be928b NC	19	Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
75be928b NC	20	02110-1301, USA. */
252b5132	21
1069dd8d ILT	22	#ifndef DEFFILE_H
	23	#define DEFFILE_H
	24
252b5132	25	/* DEF storage definitions. Note that any ordinal may be zero, and
5cc18311	26	any pointer may be NULL, if not defined by the DEF file. */
252b5132	27
e47d05ad KH	28	typedef struct def_file_section {
	29	char name; / always set */
	30	char class; / may be NULL */
	31	char flag_read, flag_write, flag_execute, flag_shared;
	32	} def_file_section;
	33
	34	typedef struct def_file_export {
	35	char name; / always set */
	36	char internal_name; / always set, may == name */
370dfff4	37	char its_name; / optional export table name referred to. */
e47d05ad KH	38	int ordinal; /* -1 if not specified */
e47d05ad KH	39	int hint;
a8d701fd	40	char flag_private, flag_constant, flag_noname, flag_data, flag_forward;
e47d05ad KH	41	} def_file_export;
	42
	43	typedef struct def_file_module {
	44	struct def_file_module *next;
	45	void *user_data;
	46	char name[1]; /* extended via malloc */
	47	} def_file_module;
	48
	49	typedef struct def_file_import {
	50	char internal_name; / always set */
	51	def_file_module module; / always set */
	52	char name; / may be NULL; either this or ordinal will be set */
370dfff4	53	char its_name; / optional import table name referred to. */
e47d05ad	54	int ordinal; /* may be -1 */
939ba9d0	55	int data; /* = 1 if data */
e47d05ad KH	56	} def_file_import;
e47d05ad KH	57
c1711530 DK	58	typedef struct def_file_aligncomm {
	59	struct def_file_aligncomm next; / Chain pointer. */
	60	char symbol_name; / Name of common symbol. */
	61	unsigned int alignment; /* log-2 alignment. */
	62	} def_file_aligncomm;
	63
e47d05ad	64	typedef struct def_file {
939ba9d0	65	/* From the NAME or LIBRARY command. */
e47d05ad KH	66	char *name;
	67	int is_dll; /* -1 if NAME/LIBRARY not given */
	68	bfd_vma base_address; /* (bfd_vma)(-1) if unspecified */
	69
939ba9d0	70	/* From the DESCRIPTION command. */
e47d05ad KH	71	char *description;
e47d05ad KH	72
939ba9d0	73	/* From the STACK/HEAP command, -1 if unspecified. */
e47d05ad KH	74	int stack_reserve, stack_commit;
	75	int heap_reserve, heap_commit;
	76
939ba9d0	77	/* From the SECTION/SEGMENT commands. */
e47d05ad KH	78	int num_section_defs;
	79	def_file_section *section_defs;
	80
939ba9d0	81	/* From the EXPORTS commands. */
e47d05ad KH	82	int num_exports;
	83	def_file_export *exports;
	84
939ba9d0	85	/* Used by imports for module names. */
e47d05ad KH	86	def_file_module *modules;
e47d05ad KH	87
939ba9d0	88	/* From the IMPORTS commands. */
e47d05ad KH	89	int num_imports;
	90	def_file_import *imports;
	91
939ba9d0	92	/* From the VERSION command, -1 if not specified. */
e47d05ad	93	int version_major, version_minor;
c1711530 DK	94
	95	/* Only expected from .drectve sections, not .DEF files. */
	96	def_file_aligncomm *aligncomms;
	97
e47d05ad	98	} def_file;
252b5132	99
1579bae1	100	extern def_file *def_file_empty (void);
252b5132	101
939ba9d0	102	/* The second arg may be NULL. If not, this .def is appended to it. */
1579bae1 AM	103	extern def_file def_file_parse (const char , def_file *);
	104	extern void def_file_free (def_file *);
	105	extern def_file_export def_file_add_export (def_file , const char *,
7fcab871	106	const char *, int,
db17156e	107	const char , int );
1579bae1	108	extern def_file_import def_file_add_import (def_file , const char *,
7fcab871	109	const char , int, const char ,
db17156e	110	const char , int );
9d8e8f44 EB	111	extern int def_file_add_import_from (def_file *fdef,
	112	int num_imports,
	113	const char *name,
	114	const char *module,
	115	int ordinal,
	116	const char *internal_name,
	117	const char *its_name);
	118	extern def_file_import def_file_add_import_at (def_file , int, const char *,
	119	const char , int, const char ,
	120	const char *);
1579bae1 AM	121	extern void def_file_add_directive (def_file , const char , int);
1579bae1 AM	122	extern def_file_module def_get_module (def_file , const char *);
252b5132	123	#ifdef DEF_FILE_PRINT
1579bae1	124	extern void def_file_print (FILE , def_file );
252b5132	125	#endif
1069dd8d ILT	126
1069dd8d ILT	127	#endif /* DEFFILE_H */