1 /* $NetBSD: search.h,v 1.1.1.1 2016/01/14 00:11:29 christos Exp $ */ 2 3 /* search.h -- Structure used to search large bodies of text, with bounds. 4 Id: search.h,v 1.3 2004/04/11 17:56:46 karl Exp 5 6 Copyright (C) 1993, 1997, 1998, 2002, 2004 Free Software Foundation, Inc. 7 8 This program is free software; you can redistribute it and/or modify 9 it under the terms of the GNU General Public License as published by 10 the Free Software Foundation; either version 2, or (at your option) 11 any later version. 12 13 This program is distributed in the hope that it will be useful, 14 but WITHOUT ANY WARRANTY; without even the implied warranty of 15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 GNU General Public License for more details. 17 18 You should have received a copy of the GNU General Public License 19 along with this program; if not, write to the Free Software 20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 21 22 Written by Brian Fox (bfox@ai.mit.edu). */ 23 24 /* The search functions take two arguments: 25 26 1) a string to search for, and 27 28 2) a pointer to a SEARCH_BINDING which contains the buffer, start, 29 and end of the search. 30 31 They return a long, which is the offset from the start of the buffer 32 at which the match was found. An offset of -1 indicates failure. */ 33 34 #ifndef INFO_SEARCH_H 35 #define INFO_SEARCH_H 36 37 typedef struct { 38 char *buffer; /* The buffer of text to search. */ 39 long start; /* Offset of the start of the search. */ 40 long end; /* Offset of the end of the searh. */ 41 int flags; /* Flags controlling the type of search. */ 42 } SEARCH_BINDING; 43 44 #define S_FoldCase 0x01 /* Set means fold case in searches. */ 45 #define S_SkipDest 0x02 /* Set means return pointing after the dest. */ 46 47 SEARCH_BINDING *make_binding (char *buffer, long int start, long int end); 48 SEARCH_BINDING *copy_binding (SEARCH_BINDING *binding); 49 extern long search_forward (char *string, SEARCH_BINDING *binding); 50 extern long search_backward (char *input_string, SEARCH_BINDING *binding); 51 extern long search (char *string, SEARCH_BINDING *binding); 52 extern int looking_at (char *string, SEARCH_BINDING *binding); 53 54 /* Note that STRING_IN_LINE () always returns the offset of the 1st character 55 after the string. */ 56 extern int string_in_line (char *string, char *line); 57 58 /* Function names that start with "skip" are passed a string, and return 59 an offset from the start of that string. Function names that start 60 with "find" are passed a SEARCH_BINDING, and return an absolute position 61 marker of the item being searched for. "Find" functions return a value 62 of -1 if the item being looked for couldn't be found. */ 63 extern int skip_whitespace (char *string); 64 extern int skip_non_whitespace (char *string); 65 extern int skip_whitespace_and_newlines (char *string); 66 extern int skip_line (char *string); 67 extern int skip_node_characters (char *string, int newlines_okay); 68 extern int skip_node_separator (char *body); 69 70 #define DONT_SKIP_NEWLINES 0 71 #define SKIP_NEWLINES 1 72 73 extern long find_node_separator (SEARCH_BINDING *binding); 74 extern long find_tags_table (SEARCH_BINDING *binding); 75 extern long find_node_in_binding (char *nodename, SEARCH_BINDING *binding); 76 77 #endif /* not INFO_SEARCH_H */ 78