# FleXML fast XML scanner framework # Copyright (c) 1999 Kristoffer Rose. All rights reserved. # # Description: Notes for FleXML scanner generator # Author: Kristoffer Rose # Created: August 1999 # License: NTSys proprietary # # 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # $Id: NOTES,v 1.3 2006/07/18 18:21:13 mquinson Exp $ GUIDELINES FOR WRITING A flex(1) SCANNER FOR SIMPLE XML FORMATS. We know how to handle the following DTD element declarations. 1. "Leaf" elements with the declarations Start conditions: %x AL_tag Rules: "" STag(tag), ETag(tag); "" STag(tag), ENTER(PCDATA); ""/>" LEAVE, Etag(tag); ">" LEAVE, ENTER(PCDATA); "" Etag(tag), LEAVE; Handlers: STag_tag(void) {...} ETag_tag(char* pcdata) {...} 2. "Logical" elements with unordered element contents using the declaration Start conditions: %x AL_tag %x IN_tag Rules: "" STag(tag), ETag(tag); "" STag(tag), ENTER(IN_tag); ""/>" LEAVE, Etag(tag); ">" BEGIN(IN_tag); "" Etag(tag); Handlers: STag_tag(void) {...} ETag_tag(char* pcdata) {...} 3. "Attribute" declarations of the form Rule: "attribute"{Eq}{Q} Attribute(tag,attribute); Handler: Attribute_tag_attribute(char* value) {...} That's all, for the moment. Note: the scanner can be made (more) validating by using the condition in front of all the rules in tag1...tagn and give the top-level rules the start condition INITIAL.