Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
CAD::Drawing::IO::FlatUser(Contributed Perl DocumCAD::Drawing::IO::FlatYAML(3)

       CAD::Drawing::IO::FlatYAML - Fast distributed YAML file methods.

       This module is a	first attempt at creating a "reference implementation"
       of the specification for	the first generation hub format	of the uber-
       converter project.  See
       for more	information about this specification.

       Eric L. Wilhelm <ewilhelm at cpan dot org>

       This module is copyright	(C) 2004-2006 by Eric L. Wilhelm.

       This module is distributed under	the same terms as Perl.	 See the Perl
       source package for details.

       You may use this	software under one of the following licenses:

	 (1) GNU General Public	License
	   (found at
	 (2) Artistic License
	   (found at

       This software is	distributed with ABSOLUTELY NO WARRANTY.  The author,
       his former employer, and	any other contributors will in no way be held
       liable for any loss or damages resulting	from its use.

       The source code of this module is made freely available and
       distributable under the GPL or Artistic License.	 Modifications to and
       use of this software must adhere	to one of these	licenses.  Changes to
       the code	should be noted	as such	and this notification (as well as the
       above copyright information) must remain	intact on all copies of	the

       Additionally, while the author is actively developing this code,
       notification of any intended changes or extensions would	be most
       helpful in avoiding repeated work for all parties involved.  Please
       contact the author with any such	development plans.


Requisite Plug-in Functions
       See CAD::Drawing::IO for	a description of the plug-in architecture.

       The command-line	type specification for this module is 'ysplit'.

       Returns true if $type is	"ysplit" or $filename is a directory (need a

	 $fact = check_type($filename, $type);

Load/Save Methods
       Concept here is to strip	data down to the absolute bare minumum in an
       effort to find a	generic	and extensible incarnation of same.

       Saves data into $toplevel_directory into	a file for each	id.

	 save($drw, $toplevel_directory, \%options);

       Requires	that the directory exists and is empty (?)

       Selective saves not yet supported.

       Needs a clear_all_like => $regex	option.

	 load($drw, $toplevel_directory, \%options);

       %options	may include selective-load arguments

Naming Functions
	 @list = _dir_list($dir);

       Remaps keys (and	possibly data) into the	input version.

	 ($key,	$value)	= keymap_in($key, $value);

       Remaps keys (and	possibly data) into the	output version.

	 ($key,	$value)	= keymap_out($key, $value);

Inherited Methods
       Removes items from the flat directory $dir.

       Defaults	to removing all.

	 $drw->clear_flatyml($dir, \%options);

       Available options:
	     like    =>	qr/regex/,  # if regex matches layer name
	     not_like => qr/regex/,  # negative	of above (compounded)

       check_select() options:
	   %options is passed through CAD::Drawing::Defined::check_select(),
	   so the selections returned by it will be utilized here.

	     select_layers => \@layer_list,
	     select_types => \@types_list,

	   Returns the number of items removed or undef() if $dir does not

perl v5.32.0			  2020-08-30	 CAD::Drawing::IO::FlatYAML(3)

NAME | DESCRIPTION | AUTHOR | COPYRIGHT | LICENSE | NO WARRANTY | Modifications | SEE ALSO | Requisite Plug-in Functions | Load/Save Methods | Naming Functions | Inherited Methods

Want to link to this manual page? Use this URL:

home | help