rb-grn-normalizer.c

/* -*- coding: utf-8; mode: C; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
  Copyright (C) 2012-2015  Kouhei Sutou <kou@clear-code.com>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License version 2.1 as published by the Free Software Foundation.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#include "rb-grn.h"

#define SELF(object, context) (RVAL2GRNNORMALIZER(object, context))

VALUE rb_cGrnNormalizer;

/*
 * Document-class: Groonga::Normalizer < Groonga::Object
 *
 * It normalizes string.
 */

/*
 * Normalizes the @string@.
 *
 * @example
 *   # Normalizes "ABC" with the default normalizer
 *   Groonga::Normalizer.normalize("AbC") # => "abc"
 *
 * @overload normalize(string, options={:remove_blank => true})
 *   @param [String] string The original string
 *
 *   @param [::Hash] options The optional parameters.
 *   @option options :normalizer
 *     We can specify using normalizer.
 *   @option options :remove_blank (true)
 *     If it's `true`, all blank characters are removed.
 *   @option options :remove_tokenized_delimiter (false)
 *     If it's `true`, all tokenized delimiter characters are removed.
 *     The character is `U+FFFE`.
 *
 *   @return [String] The normalized string
 */
static VALUE
rb_grn_normalizer_s_normalize (int argc, VALUE *argv, VALUE klass)
{
    VALUE rb_context = Qnil;
    VALUE rb_string;
    VALUE rb_options;
    VALUE rb_normalizer_p;
    VALUE rb_remove_blank_p;
    VALUE rb_remove_tokenized_delimiter_p;
    VALUE rb_encoded_string;
    VALUE rb_normalized_string;
    grn_ctx *context = NULL;
    grn_obj *grn_string;
    grn_obj *normalizer = GRN_NORMALIZER_AUTO;
    int flags = 0;
    const char *normalized_string;
    unsigned int normalized_string_length;

    rb_scan_args(argc, argv, "11", &rb_string, &rb_options);
    rb_grn_scan_options(rb_options,
                        "normalizer", &rb_normalizer_p,
                        "remove_blank", &rb_remove_blank_p,
                        "remove_tokenized_delimiter_p",
                        &rb_remove_tokenized_delimiter_p,
                        NULL);

    context = rb_grn_context_ensure(&rb_context);
    rb_encoded_string = rb_grn_context_rb_string_encode(context, rb_string);
    if (RSTRING_LEN(rb_encoded_string) == 0) {
        return rb_grn_context_rb_string_new(context, "", 0);
    }

    if (!NIL_P(rb_normalizer_p)) {
        normalizer = RVAL2GRNOBJECT(rb_normalizer_p, &context);
    }
    if (NIL_P(rb_remove_blank_p)) {
        rb_remove_blank_p = Qtrue;
    }
    if (RVAL2CBOOL(rb_remove_blank_p)) {
        flags |= GRN_STRING_REMOVE_BLANK;
    }
    if (NIL_P(rb_remove_tokenized_delimiter_p)) {
        rb_remove_tokenized_delimiter_p = Qfalse;
    }
    if (RVAL2CBOOL(rb_remove_tokenized_delimiter_p)) {
        flags |= GRN_STRING_REMOVE_TOKENIZED_DELIMITER;
    }
    grn_string = grn_string_open(context,
                                 RSTRING_PTR(rb_encoded_string),
                                 RSTRING_LEN(rb_encoded_string),
                                 normalizer,
                                 flags);
    rb_grn_context_check(context, argv[0]);
    if (!grn_string) {
        return Qnil;
    }
    grn_string_get_normalized(context, grn_string,
                              &normalized_string, &normalized_string_length,
                              NULL);
    rb_normalized_string =
        rb_grn_context_rb_string_new(context,
                                     normalized_string,
                                     normalized_string_length);
    grn_obj_close(context, grn_string);

    return rb_normalized_string;
}

void
rb_grn_init_normalizer (VALUE mGrn)
{
    rb_cGrnNormalizer = rb_define_class_under(mGrn, "Normalizer", rb_cObject);

    rb_define_singleton_method(rb_cGrnNormalizer, "normalize",
                               rb_grn_normalizer_s_normalize, -1);
}