char.hh

Go to the documentation of this file.

#pragma once

#include <cassert>
#include <string>
#include <iostream>

#include <vcsn/misc/escape.hh>
#include <vcsn/misc/format.hh>
#include <vcsn/misc/raise.hh>
#include <vcsn/misc/stream.hh>
#include <vcsn/misc/symbol.hh>

namespace vcsn
{
  class char_letters
  {
  public:
    using letter_t = char;
    using word_t = std::string;

    static symbol sname()
    {
      static auto res = symbol{"char_letters"};
      return res;
    }

    word_t
    to_word(const letter_t l) const
    {
      return {l};
    }

    const word_t&
    to_word(const word_t& l) const
    {
      return l;
    }

    word_t
    mul(const letter_t l, const letter_t r) const
    {
      if (l == one_letter())
        {
          if (r == one_letter())
            return {};
          else
            return {l};
        }
      else if (r == one_letter())
        return {l};
      else
        return {l, r};
    }

    word_t
    mul(const word_t& l, const letter_t r) const
    {
      return r == one_letter() ? l : l + r;
    }

    word_t
    mul(const letter_t l, const word_t& r) const
    {
      return l == one_letter() ? r : l + r;
    }

    word_t
    mul(const word_t& l, const word_t& r) const
    {
      return l + r;
    }

    word_t delimit(const word_t& w) const
    {
      return mul(mul(special_letter(), w), special_letter());
    }

    word_t undelimit(const word_t& w) const
    {
      size_t s = w.size();
      assert(2 <= s);
      assert(w[0] == special_letter());
      assert(w[s-1] == special_letter());
      return w.substr(1, s-2);
    }

    static word_t
    empty_word()
    {
      return {};
    }

    static bool
    is_empty_word(const word_t& w)
    {
      return w.empty();
    }

    word_t
    transpose(const word_t& w) const
    {
      // C++11 lacks std::rbegin/rend...
      return {w.rbegin(), w.rend()};
    }

    letter_t
    transpose(letter_t l) const
    {
      return l;
    }

    static int compare(const letter_t l, const letter_t r)
    {
      return int(uint8_t(l)) - int(uint8_t(r));
    }

    static int compare(const word_t& l, const word_t& r)
    {
      return l.compare(r);
    }

    static bool equal(const letter_t l, const letter_t r)
    {
      return l == r;
    }

    static bool equal(const word_t& l, const word_t& r)
    {
      return l == r;
    }

    static bool less(const letter_t l, const letter_t r)
    {
      // Be sure to convert the whole 8-bit spectrum.
      return uint8_t(l) < uint8_t(r);
    }

    static bool less(const word_t& l, const word_t& r)
    {
      // FIXME: do we need an unsigned comparison?
      return l < r;
    }

    bool is_letter(const letter_t) const
    {
      return true;
    }

    bool is_letter(const word_t& w) const
    {
      return w.size() == 1;
    }

    static constexpr letter_t one_letter() { return 0; }

  private:
    static constexpr letter_t special_letter() { return -1; }

  public:
    static letter_t get_letter(std::istream& i, bool quoted = true)
    {
      letter_t res = i.peek();
      if (quoted && res == '\'')
        {
          eat(i, '\'');
          res = get_char(i);
          eat(i, '\'');
        }
      else
        res = get_char(i);
      return res;
    }

    std::ostream&
    print(const letter_t l, std::ostream& o, format fmt = {}) const
    {
      if (l == one_letter() || l == special_letter())
        {}
      else
        switch (fmt.kind())
          {
          case format::sname:
            // Escape dash and parens, which are special when parsed
            // (actually, only the closing paren is special, but treating
            // them symmetrically is better looking).
            //
            // Of course, escape single-quote and backslash, which are
            // used to escape.
            str_escape(o, l, "(-)\\'");
            break;

          case format::latex:
            if (l == '\\')
              o << "\\backslash{}";
            else
              str_escape(o, l, "#{}$");
            break;

          case format::raw:
            o << l;
            break;

          case format::text:
          case format::utf8:
            if (l == '\\')
              o << "\\\\";
            else
              str_escape(o, l, fmt.meta() ? fmt.meta() : "|',[-]<> ");
          }
      return o;
    }

    std::ostream&
    print(const word_t& w, std::ostream& o, format fmt = {}) const
    {
      size_t s = w.size();

      if (s == 0
          || (s == 1 && w[0] == one_letter()))
        o << "\\e";
      else if (s == 1 && w[0] == special_letter())
        o << '$';
      else if (fmt == format::raw)
        o << w;
      else
        {
          if (fmt == format::latex)
            o << "\\mathit{";
          for (auto c: w)
            print(c, o, fmt);
          if (fmt == format::latex)
            o << '}';
        }
      return o;
    }

    template <typename T = letter_t>
    static T special();
  };

  template <>
  inline
  char_letters::letter_t
  char_letters::special<char_letters::letter_t>()
  {
    return special_letter();
  }

  template <>
  inline
  char_letters::word_t
  char_letters::special<char_letters::word_t>()
  {
    return {special_letter()};
  }

}