File_parser Class Reference

Inheritance diagram for File_parser:

List of all members.

Public Member Functions
my_bool	ok ()
const LEX_STRING *	type () const
my_bool	parse (uchar *base, MEM_ROOT *mem_root, struct File_option *parameters, uint required, Unknown_key_hook *hook) const
Friends
File_parser *	sql_parse_prepare (const LEX_STRING *file_name, MEM_ROOT *mem_root, bool bad_format_errors)

---

Member Function Documentation

my_bool File_parser::parse	(	uchar *	base,
		MEM_ROOT *	mem_root,
		struct File_option *	parameters,
		uint	required,
		Unknown_key_hook *	hook
	)		const

parse parameters.

Parameters:

base	base address for parameter writing (structure like TABLE)
mem_root	MEM_ROOT for parameters allocation
parameters	parameters description
required	number of required parameters in above list. If the file contains more parameters than "required", they will be ignored. If the file contains less parameters then "required", non-existing parameters will remain their values.
hook	hook called for unknown keys
hook_data	some data specific for the hook

Return values:

FALSE	OK
TRUE	error

---

Friends And Related Function Documentation

File_parser* sql_parse_prepare	(	const LEX_STRING *	file_name,
		MEM_ROOT *	mem_root,
		bool	bad_format_errors
	)		[friend]

Prepare frm to parse (read to memory).

Parameters:

file_name	path & filename to .frm file
mem_root	MEM_ROOT for buffer allocation
bad_format_errors	send errors on bad content

Note:

returned pointer + 1 will be type of .frm

Returns:

0 - error

parser object

---

The documentation for this class was generated from the following files:

• parse_file.h
• parse_file.cc