libbeagle/beagle/beagle-query-part-text.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; -*- */
   2
   3 /*
   4  * beagle-query-part-text.c
   5  *
   6  * Copyright (C) 2005 Novell, Inc.
   7  *
   8  */
   9
  10 /*
  11  * Permission is hereby granted, free of charge, to any person obtaining a
  12  * copy of this software and associated documentation files (the "Software"),
  13  * to deal in the Software without restriction, including without limitation
  14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  15  * and/or sell copies of the Software, and to permit persons to whom the
  16  * Software is furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  27  * DEALINGS IN THE SOFTWARE.
  28  */
  29
  30 #include <string.h>
  31
  32 #include "beagle-private.h"
  33 #include "beagle-query-part.h"
  34 #include "beagle-query-part-text.h"
  35
  36 typedef struct {
  37         const char *text;
  38         gboolean search_full_text : 1;
  39         gboolean search_properties : 1;
  40 } BeagleQueryPartTextPrivate;
  41
  42 #define BEAGLE_QUERY_PART_TEXT_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), BEAGLE_TYPE_QUERY_PART_TEXT, BeagleQueryPartTextPrivate))
  43
  44 static GObjectClass *parent_class = NULL;
  45
  46 G_DEFINE_TYPE (BeagleQueryPartText, beagle_query_part_text, BEAGLE_TYPE_QUERY_PART)
  47
  48 static GString *
  49 beagle_query_part_text_to_xml (BeagleQueryPart *part)
  50 {
  51         BeagleQueryPartTextPrivate *priv = BEAGLE_QUERY_PART_TEXT_GET_PRIVATE (part);
  52         GString *data = g_string_new (NULL);
  53
  54         _beagle_query_part_append_standard_header (data, part, "Text");
  55
  56         g_string_append (data, "<Text>");
  57         g_string_append (data, priv->text);
  58         g_string_append (data, "</Text>");
  59
  60         if (priv->search_full_text)
  61                 g_string_append (data, "<SearchFullText>true</SearchFullText>");
  62         else
  63                 g_string_append (data, "<SearchFullText>false</SearchFullText>");
  64
  65         if (priv->search_properties)
  66                 g_string_append (data, "<SearchTextProperties>true</SearchTextProperties>");
  67         else
  68                 g_string_append (data, "<SearchTextProperties>false</SearchTextProperties>");
  69
  70         _beagle_query_part_append_standard_footer (data);
  71
  72         return data;
  73 }
  74
  75 static void
  76 beagle_query_part_text_finalize (GObject *obj)
  77 {
  78         if (G_OBJECT_CLASS (parent_class)->finalize)
  79                 G_OBJECT_CLASS (parent_class)->finalize (obj);
  80 }
  81
  82 static void
  83 beagle_query_part_text_class_init (BeagleQueryPartTextClass *klass)
  84 {
  85         GObjectClass *obj_class = G_OBJECT_CLASS (klass);
  86         BeagleQueryPartClass *query_part_class = BEAGLE_QUERY_PART_CLASS (klass);
  87
  88         parent_class = g_type_class_peek_parent (klass);
  89
  90         obj_class->finalize = beagle_query_part_text_finalize;
  91         query_part_class->to_xml = beagle_query_part_text_to_xml;
  92
  93         g_type_class_add_private (klass, sizeof (BeagleQueryPartTextPrivate));
  94 }
  95
  96 static void
  97 beagle_query_part_text_init (BeagleQueryPartText *part)
  98 {
  99
 100 }
 101
 102 BeagleQueryPartText *
 103 beagle_query_part_text_new (void)
 104 {
 105         BeagleQueryPartText *part = g_object_new (BEAGLE_TYPE_QUERY_PART_TEXT, 0);
 106         return part;
 107 }
 108
 109 /**
 110  * beagle_query_part_text_set_text:
 111  * @part: a #BeagleQueryPartText
 112  * @text: a #const char *
 113  *
 114  * Sets the text to search for in a #BeagleQueryPartText.  This should only
 115  * be used for programmatically built queries, because it does not use the
 116  * query language and doesn't handle things like "OR".  If you are getting
 117  * input from a user, you should use #BeagleQueryPartHuman instead.
 118  **/
 119 void
 120 beagle_query_part_text_set_text (BeagleQueryPartText *part,
 121                                  const char          *text)
 122 {
 123         BeagleQueryPartTextPrivate *priv;
 124
 125         g_return_if_fail (BEAGLE_IS_QUERY_PART_TEXT (part));
 126         g_return_if_fail (text != NULL);
 127
 128         priv = BEAGLE_QUERY_PART_TEXT_GET_PRIVATE (part);
 129         priv->text = text;
 130 }
 131
 132 /**
 133  * beagle_query_part_text_set_search_full_text:
 134  * @part: a #BeagleQueryPartText
 135  * @search_full_text: a #gboolean
 136  *
 137  * Sets whether to search the full text of documents to find the text part
 138  * of this #BeagleQueryPartText.
 139  **/
 140 void
 141 beagle_query_part_text_set_search_full_text (BeagleQueryPartText *part,
 142                                              gboolean            search_full_text)
 143 {
 144         BeagleQueryPartTextPrivate *priv;
 145
 146         g_return_if_fail (BEAGLE_IS_QUERY_PART_TEXT (part));
 147
 148         priv = BEAGLE_QUERY_PART_TEXT_GET_PRIVATE (part);
 149         priv->search_full_text = search_full_text;
 150 }
 151
 152 /**
 153  * beagle_query_part_text_set_search_properties:
 154  * @part: a #BeagleQueryPartText
 155  * @search_properties: a #gboolean
 156  *
 157  * Sets whether to search the properties of documents to find the text part
 158  * of this #BeagleQueryPartText.
 159  **/
 160 void
 161 beagle_query_part_text_set_search_properties (BeagleQueryPartText *part,
 162                                               gboolean            search_properties)
 163 {
 164         BeagleQueryPartTextPrivate *priv;
 165
 166         g_return_if_fail (BEAGLE_IS_QUERY_PART_TEXT (part));
 167
 168         priv = BEAGLE_QUERY_PART_TEXT_GET_PRIVATE (part);
 169         priv->search_properties = search_properties;
 170 }
 171