src/info.h

   1 /*
   2  * info.h: filename/linenumber information for parser/interpreter
   3  *
   4  * Copyright (C) 2007-2015 David Lutterkort
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
  19  *
  20  * Author: David Lutterkort <lutter@redhat.com>
  21  */
  22
  23 #ifndef INFO_H_
  24 #define INFO_H_
  25
  26 #include <stdio.h>
  27 #include <stdint.h>
  28 #include <stdlib.h>
  29 #include "ref.h"
  30
  31 /* Reference-counted strings */
  32 struct string {
  33     ref_t   ref;
  34     char   *str;
  35 };
  36
  37 struct string *make_string(char *str);
  38
  39 /* Duplicate a string; if STR is NULL, use the empty string "" */
  40 struct string *dup_string(const char *str);
  41
  42 /* Do not call directly, use UNREF instead */
  43 void free_string(struct string *string);
  44
  45 /* File information */
  46 struct info {
  47     /* There is only one struct error for each Augeas instance */
  48     struct error  *error;
  49     struct string *filename;
  50     uint16_t first_line;
  51     uint16_t first_column;
  52     uint16_t last_line;
  53     uint16_t last_column;
  54     ref_t    ref;
  55     int flags;
  56 };
  57
  58 struct span {
  59     struct string *filename;
  60     uint label_start;
  61     uint label_end;
  62     uint value_start;
  63     uint value_end;
  64     uint span_start;
  65     uint span_end;
  66 };
  67
  68 char *format_info(struct info *info);
  69
  70 void print_info(FILE *out, struct info *info);
  71
  72 /* Do not call directly, use UNREF instead */
  73 void free_info(struct info *info);
  74
  75 struct span *make_span(struct info *info);
  76 void free_span(struct span *node_info);
  77 void update_span(struct span *node_info, int x, int y);
  78 void print_span(struct span *node_info);
  79 #endif
  80
  81
  82 /*
  83  * Local variables:
  84  *  indent-tabs-mode: nil
  85  *  c-indent-level: 4
  86  *  c-basic-offset: 4
  87  *  tab-width: 4
  88  * End:
  89  */