strflags.h File Reference

Prototypes for strflags. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
FlagType	string_to_flags (const char *flagstring, int(*error)(const char *msg))
	Convert strings to flags.
char *	flags_to_string (FlagType flags, int object_type)
	Object flags converted to strings.
FlagType	string_to_pcbflags (const char *flagstring, int(*error)(const char *msg))
	Convert strings to PCB flags.
char *	pcbflags_to_string (FlagType flags)
	PCB flags converted to strings.
void	uninit_strflags_buf (void)
void	uninit_strflags_layerlist (void)

---

Detailed Description

Prototypes for strflags.

The purpose of this interface is to make the file format able to handle more than 32 flags, and to hide the internal details of flags from the file format.

---

Copyright.

PCB, interactive printed circuit board design

Copyright (C) 2005 DJ Delorie

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 2 of the License, or (at your option) any later version.

This 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 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Contact addresses for paper mail and Email:

DJ Delorie, 334 North Road, Deerfield NH 03037-1110, USA

dj@delorie.com

Definition in file strflags.h.

---

Function Documentation

char* flags_to_string	(	FlagType	flags,
		int	object_type
	)

Object flags converted to strings.

Given a set of flags for a given object type, return a string which can be output to a file.

The returned pointer must not be freed.

Definition at line 629 of file strflags.c.

References common_flags_to_string(), and ENTRIES.

Referenced by choose_example_line(), new_line(), ReportDialog(), and UndoFlag().

Here is the call graph for this function:

char* pcbflags_to_string

(

FlagType

flags

)

PCB flags converted to strings.

Definition at line 641 of file strflags.c.

References common_flags_to_string(), and ENTRIES.

Referenced by WritePCBDataHeader().

Here is the call graph for this function:

FlagType string_to_flags	(	const char *	flagstring,
		int(*)(const char *msg)	error
	)

Convert strings to flags.

When passed a string, parse it and return an appropriate set of flags.

Errors cause error() to be called with a suitable message; if error is NULL, errors are ignored.

Definition at line 497 of file strflags.c.

References common_string_to_flags(), ENTRIES, and error.

Here is the call graph for this function:

FlagType string_to_pcbflags	(	const char *	flagstring,
		int(*)(const char *msg)	error
	)

Convert strings to PCB flags.

When passed a string, parse it and return an appropriate set of flags.

Errors cause error() to be called with a suitable message; if error is NULL, errors are ignored.

Definition at line 516 of file strflags.c.

References common_string_to_flags(), ENTRIES, and error.

Here is the call graph for this function:

void uninit_strflags_buf

(

void

)

Definition at line 175 of file strflags.c.

References buffers, n, and ptr.

Referenced by pcb_main_uninit().

void uninit_strflags_layerlist

(

void

)

Definition at line 222 of file strflags.c.

References layers, max_layers, and num_layers.

Referenced by pcb_main_uninit().