6 * Use, modification and distribution are subject to the
7 * Boost Software License, Version 1.0. (See accompanying file
8 * LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
13 * LOCATION: see http://www.boost.org for most recent version.
14 * FILE w32_regex_traits.hpp
15 * VERSION see <boost/version.hpp>
16 * DESCRIPTION: Declares regular expression traits class w32_regex_traits.
19 #ifndef BOOST_W32_REGEX_TRAITS_HPP_INCLUDED
20 #define BOOST_W32_REGEX_TRAITS_HPP_INCLUDED
22 #ifndef BOOST_RE_PAT_EXCEPT_HPP
23 #include <boost/regex/pattern_except.hpp>
25 #ifndef BOOST_REGEX_TRAITS_DEFAULTS_HPP_INCLUDED
26 #include <boost/regex/v4/regex_traits_defaults.hpp>
28 #ifdef BOOST_HAS_THREADS
29 #include <boost/regex/pending/static_mutex.hpp>
31 #ifndef BOOST_REGEX_PRIMARY_TRANSFORM
32 #include <boost/regex/v4/primary_transform.hpp>
34 #ifndef BOOST_REGEX_OBJECT_CACHE_HPP
35 #include <boost/regex/pending/object_cache.hpp>
38 #ifdef BOOST_HAS_ABI_HEADERS
39 # include BOOST_ABI_PREFIX
44 #pragma warning(disable:4786)
50 // forward declaration is needed by some compilers:
52 template <class charT>
53 class w32_regex_traits;
58 // start by typedeffing the types we'll need:
60 typedef ::boost::uint32_t lcid_type; // placeholder for LCID.
61 typedef ::boost::shared_ptr<void> cat_type; // placeholder for dll HANDLE.
64 // then add wrappers around the actual Win32 API's (ie implementation hiding):
66 BOOST_REGEX_DECL lcid_type BOOST_REGEX_CALL w32_get_default_locale();
67 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_lower(char, lcid_type);
68 #ifndef BOOST_NO_WREGEX
69 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_lower(wchar_t, lcid_type);
70 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
71 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_lower(unsigned short ca, lcid_type id);
74 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_upper(char, lcid_type);
75 #ifndef BOOST_NO_WREGEX
76 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_upper(wchar_t, lcid_type);
77 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
78 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_upper(unsigned short ca, lcid_type id);
81 BOOST_REGEX_DECL cat_type BOOST_REGEX_CALL w32_cat_open(const std::string& name);
82 BOOST_REGEX_DECL std::string BOOST_REGEX_CALL w32_cat_get(const cat_type& cat, lcid_type id, int i, const std::string& def);
83 #ifndef BOOST_NO_WREGEX
84 BOOST_REGEX_DECL std::wstring BOOST_REGEX_CALL w32_cat_get(const cat_type& cat, lcid_type id, int i, const std::wstring& def);
85 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
86 BOOST_REGEX_DECL std::basic_string<unsigned short> BOOST_REGEX_CALL w32_cat_get(const cat_type& cat, lcid_type, int i, const std::basic_string<unsigned short>& def);
89 BOOST_REGEX_DECL std::string BOOST_REGEX_CALL w32_transform(lcid_type id, const char* p1, const char* p2);
90 #ifndef BOOST_NO_WREGEX
91 BOOST_REGEX_DECL std::wstring BOOST_REGEX_CALL w32_transform(lcid_type id, const wchar_t* p1, const wchar_t* p2);
92 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
93 BOOST_REGEX_DECL std::basic_string<unsigned short> BOOST_REGEX_CALL w32_transform(lcid_type id, const unsigned short* p1, const unsigned short* p2);
96 BOOST_REGEX_DECL char BOOST_REGEX_CALL w32_tolower(char c, lcid_type);
97 #ifndef BOOST_NO_WREGEX
98 BOOST_REGEX_DECL wchar_t BOOST_REGEX_CALL w32_tolower(wchar_t c, lcid_type);
99 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
100 BOOST_REGEX_DECL unsigned short BOOST_REGEX_CALL w32_tolower(unsigned short c, lcid_type id);
103 BOOST_REGEX_DECL char BOOST_REGEX_CALL w32_toupper(char c, lcid_type);
104 #ifndef BOOST_NO_WREGEX
105 BOOST_REGEX_DECL wchar_t BOOST_REGEX_CALL w32_toupper(wchar_t c, lcid_type);
107 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is(lcid_type, boost::uint32_t mask, char c);
108 #ifndef BOOST_NO_WREGEX
109 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is(lcid_type, boost::uint32_t mask, wchar_t c);
110 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
111 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is(lcid_type id, boost::uint32_t m, unsigned short c);
115 // class w32_regex_traits_base:
116 // acts as a container for locale and the facets we are using.
118 template <class charT>
119 struct w32_regex_traits_base
121 w32_regex_traits_base(lcid_type l)
123 lcid_type imbue(lcid_type l);
128 template <class charT>
129 inline lcid_type w32_regex_traits_base<charT>::imbue(lcid_type l)
131 lcid_type result(m_locale);
137 // class w32_regex_traits_char_layer:
138 // implements methods that require specialisation for narrow characters:
140 template <class charT>
141 class w32_regex_traits_char_layer : public w32_regex_traits_base<charT>
143 typedef std::basic_string<charT> string_type;
144 typedef std::map<charT, regex_constants::syntax_type> map_type;
145 typedef typename map_type::const_iterator map_iterator_type;
147 w32_regex_traits_char_layer(const lcid_type l);
149 regex_constants::syntax_type syntax_type(charT c)const
151 map_iterator_type i = m_char_map.find(c);
152 return ((i == m_char_map.end()) ? 0 : i->second);
154 regex_constants::escape_syntax_type escape_syntax_type(charT c) const
156 map_iterator_type i = m_char_map.find(c);
157 if(i == m_char_map.end())
159 if(::boost::re_detail::w32_is_lower(c, this->m_locale)) return regex_constants::escape_type_class;
160 if(::boost::re_detail::w32_is_upper(c, this->m_locale)) return regex_constants::escape_type_not_class;
165 charT tolower(charT c)const
167 return ::boost::re_detail::w32_tolower(c, this->m_locale);
169 bool isctype(boost::uint32_t mask, charT c)const
171 return ::boost::re_detail::w32_is(this->m_locale, mask, c);
175 string_type get_default_message(regex_constants::syntax_type);
176 // TODO: use a hash table when available!
180 template <class charT>
181 w32_regex_traits_char_layer<charT>::w32_regex_traits_char_layer(::boost::re_detail::lcid_type l)
182 : w32_regex_traits_base<charT>(l)
184 // we need to start by initialising our syntax map so we know which
185 // character is used for which purpose:
187 std::string cat_name(w32_regex_traits<charT>::get_catalog_name());
190 cat = ::boost::re_detail::w32_cat_open(cat_name);
193 std::string m("Unable to open message catalog: ");
194 std::runtime_error err(m + cat_name);
195 boost::re_detail::raise_runtime_error(err);
199 // if we have a valid catalog then load our messages:
203 for(regex_constants::syntax_type i = 1; i < regex_constants::syntax_max; ++i)
205 string_type mss = ::boost::re_detail::w32_cat_get(cat, this->m_locale, i, get_default_message(i));
206 for(typename string_type::size_type j = 0; j < mss.size(); ++j)
208 this->m_char_map[mss[j]] = i;
214 for(regex_constants::syntax_type i = 1; i < regex_constants::syntax_max; ++i)
216 const char* ptr = get_default_syntax(i);
219 this->m_char_map[static_cast<charT>(*ptr)] = i;
226 template <class charT>
227 typename w32_regex_traits_char_layer<charT>::string_type
228 w32_regex_traits_char_layer<charT>::get_default_message(regex_constants::syntax_type i)
230 const char* ptr = get_default_syntax(i);
234 result.append(1, static_cast<charT>(*ptr));
241 // specialised version for narrow characters:
244 class BOOST_REGEX_DECL w32_regex_traits_char_layer<char> : public w32_regex_traits_base<char>
246 typedef std::string string_type;
248 w32_regex_traits_char_layer(::boost::re_detail::lcid_type l)
249 : w32_regex_traits_base<char>(l)
254 regex_constants::syntax_type syntax_type(char c)const
256 return m_char_map[static_cast<unsigned char>(c)];
258 regex_constants::escape_syntax_type escape_syntax_type(char c) const
260 return m_char_map[static_cast<unsigned char>(c)];
262 char tolower(char c)const
264 return m_lower_map[static_cast<unsigned char>(c)];
266 bool isctype(boost::uint32_t mask, char c)const
268 return m_type_map[static_cast<unsigned char>(c)] & mask;
272 regex_constants::syntax_type m_char_map[1u << CHAR_BIT];
273 char m_lower_map[1u << CHAR_BIT];
274 boost::uint16_t m_type_map[1u << CHAR_BIT];
279 // class w32_regex_traits_implementation:
280 // provides pimpl implementation for w32_regex_traits.
282 template <class charT>
283 class w32_regex_traits_implementation : public w32_regex_traits_char_layer<charT>
286 typedef typename w32_regex_traits<charT>::char_class_type char_class_type;
287 BOOST_STATIC_CONSTANT(char_class_type, mask_word = 0x0400); // must be C1_DEFINED << 1
288 BOOST_STATIC_CONSTANT(char_class_type, mask_unicode = 0x0800); // must be C1_DEFINED << 2
289 BOOST_STATIC_CONSTANT(char_class_type, mask_base = 0x3ff); // all the masks used by the CT_CTYPE1 group
291 typedef std::basic_string<charT> string_type;
292 typedef charT char_type;
293 w32_regex_traits_implementation(::boost::re_detail::lcid_type l);
294 std::string error_string(regex_constants::error_type n) const
296 if(!m_error_strings.empty())
298 std::map<int, std::string>::const_iterator p = m_error_strings.find(n);
299 return (p == m_error_strings.end()) ? std::string(get_default_error_string(n)) : p->second;
301 return get_default_error_string(n);
303 char_class_type lookup_classname(const charT* p1, const charT* p2) const
305 char_class_type result = lookup_classname_imp(p1, p2);
308 typedef typename string_type::size_type size_type;
309 string_type temp(p1, p2);
310 for(size_type i = 0; i < temp.size(); ++i)
311 temp[i] = this->tolower(temp[i]);
312 result = lookup_classname_imp(&*temp.begin(), &*temp.begin() + temp.size());
316 string_type lookup_collatename(const charT* p1, const charT* p2) const;
317 string_type transform_primary(const charT* p1, const charT* p2) const;
318 string_type transform(const charT* p1, const charT* p2) const
320 return ::boost::re_detail::w32_transform(this->m_locale, p1, p2);
323 std::map<int, std::string> m_error_strings; // error messages indexed by numberic ID
324 std::map<string_type, char_class_type> m_custom_class_names; // character class names
325 std::map<string_type, string_type> m_custom_collate_names; // collating element names
326 unsigned m_collate_type; // the form of the collation string
327 charT m_collate_delim; // the collation group delimiter
331 char_class_type lookup_classname_imp(const charT* p1, const charT* p2) const;
334 template <class charT>
335 typename w32_regex_traits_implementation<charT>::string_type
336 w32_regex_traits_implementation<charT>::transform_primary(const charT* p1, const charT* p2) const
340 // What we do here depends upon the format of the sort key returned by
341 // sort key returned by this->transform:
343 switch(m_collate_type)
347 // the best we can do is translate to lower case, then get a regular sort key:
349 result.assign(p1, p2);
350 typedef typename string_type::size_type size_type;
351 for(size_type i = 0; i < result.size(); ++i)
352 result[i] = this->tolower(result[i]);
353 result = this->transform(&*result.begin(), &*result.begin() + result.size());
358 // get a regular sort key, and then truncate it:
359 result.assign(this->transform(p1, p2));
360 result.erase(this->m_collate_delim);
364 // get a regular sort key, and then truncate everything after the delim:
365 result.assign(this->transform(p1, p2));
367 for(i = 0; i < result.size(); ++i)
369 if(result[i] == m_collate_delim)
376 result = string_type(1, charT(0));
380 template <class charT>
381 typename w32_regex_traits_implementation<charT>::string_type
382 w32_regex_traits_implementation<charT>::lookup_collatename(const charT* p1, const charT* p2) const
384 typedef typename std::map<string_type, string_type>::const_iterator iter_type;
385 if(m_custom_collate_names.size())
387 iter_type pos = m_custom_collate_names.find(string_type(p1, p2));
388 if(pos != m_custom_collate_names.end())
391 #if !defined(BOOST_NO_TEMPLATED_ITERATOR_CONSTRUCTORS)\
392 && !BOOST_WORKAROUND(BOOST_MSVC, < 1300)\
393 && !BOOST_WORKAROUND(__BORLANDC__, <= 0x0551)
394 std::string name(p1, p2);
397 const charT* p0 = p1;
399 name.append(1, char(*p0++));
401 name = lookup_default_collate_name(name);
402 #if !defined(BOOST_NO_TEMPLATED_ITERATOR_CONSTRUCTORS)\
403 && !BOOST_WORKAROUND(BOOST_MSVC, < 1300)\
404 && !BOOST_WORKAROUND(__BORLANDC__, <= 0x0551)
406 return string_type(name.begin(), name.end());
411 typedef std::string::const_iterator iter;
412 iter b = name.begin();
415 result.append(1, charT(*b++));
420 return string_type(1, *p1);
421 return string_type();
424 template <class charT>
425 w32_regex_traits_implementation<charT>::w32_regex_traits_implementation(::boost::re_detail::lcid_type l)
426 : w32_regex_traits_char_layer<charT>(l)
429 std::string cat_name(w32_regex_traits<charT>::get_catalog_name());
432 cat = ::boost::re_detail::w32_cat_open(cat_name);
435 std::string m("Unable to open message catalog: ");
436 std::runtime_error err(m + cat_name);
437 boost::re_detail::raise_runtime_error(err);
441 // if we have a valid catalog then load our messages:
448 for(boost::regex_constants::error_type i = static_cast<boost::regex_constants::error_type>(0);
449 i <= boost::regex_constants::error_unknown;
450 i = static_cast<boost::regex_constants::error_type>(i + 1))
452 const char* p = get_default_error_string(i);
453 string_type default_message;
456 default_message.append(1, static_cast<charT>(*p));
459 string_type s = ::boost::re_detail::w32_cat_get(cat, this->m_locale, i+200, default_message);
461 for(std::string::size_type j = 0; j < s.size(); ++j)
463 result.append(1, static_cast<char>(s[j]));
465 m_error_strings[i] = result;
468 // Custom class names:
470 static const char_class_type masks[14] =
472 0x0104u, // C1_ALPHA | C1_DIGIT
476 (~(0x0020u|0x0008u) & 0x01ffu) | 0x0400u, // not C1_CNTRL or C1_SPACE
478 (~0x0020u & 0x01ffu) | 0x0400, // not C1_CNTRL
482 0x0080u, // C1_XDIGIT
484 w32_regex_traits_implementation<charT>::mask_word,
485 w32_regex_traits_implementation<charT>::mask_unicode,
487 static const string_type null_string;
488 for(unsigned int j = 0; j <= 13; ++j)
490 string_type s(::boost::re_detail::w32_cat_get(cat, this->m_locale, j+300, null_string));
492 this->m_custom_class_names[s] = masks[j];
496 // get the collation format used by m_pcollate:
498 m_collate_type = re_detail::find_sort_syntax(this, &m_collate_delim);
501 template <class charT>
502 typename w32_regex_traits_implementation<charT>::char_class_type
503 w32_regex_traits_implementation<charT>::lookup_classname_imp(const charT* p1, const charT* p2) const
505 static const char_class_type masks[20] =
508 0x0104u, // C1_ALPHA | C1_DIGIT
514 (~(0x0020u|0x0008u|0x0040) & 0x01ffu) | 0x0400u, // not C1_CNTRL or C1_SPACE or C1_BLANK
517 (~0x0020u & 0x01ffu) | 0x0400, // not C1_CNTRL
522 w32_regex_traits_implementation<charT>::mask_unicode,
524 0x0104u | w32_regex_traits_implementation<charT>::mask_word,
525 0x0104u | w32_regex_traits_implementation<charT>::mask_word,
526 0x0080u, // C1_XDIGIT
528 if(m_custom_class_names.size())
530 typedef typename std::map<std::basic_string<charT>, char_class_type>::const_iterator map_iter;
531 map_iter pos = m_custom_class_names.find(string_type(p1, p2));
532 if(pos != m_custom_class_names.end())
535 std::size_t id = 1 + re_detail::get_default_class_id(p1, p2);
536 if(id < sizeof(masks) / sizeof(masks[0]))
542 template <class charT>
543 boost::shared_ptr<const w32_regex_traits_implementation<charT> > create_w32_regex_traits(::boost::re_detail::lcid_type l BOOST_APPEND_EXPLICIT_TEMPLATE_TYPE(charT))
545 // TODO: create a cache for previously constructed objects.
546 return boost::object_cache< ::boost::re_detail::lcid_type, w32_regex_traits_implementation<charT> >::get(l, 5);
551 template <class charT>
552 class w32_regex_traits
555 typedef charT char_type;
556 typedef std::size_t size_type;
557 typedef std::basic_string<char_type> string_type;
558 typedef ::boost::re_detail::lcid_type locale_type;
559 typedef boost::uint_least32_t char_class_type;
561 struct boost_extensions_tag{};
564 : m_pimpl(re_detail::create_w32_regex_traits<charT>(::boost::re_detail::w32_get_default_locale()))
566 static size_type length(const char_type* p)
568 return std::char_traits<charT>::length(p);
570 regex_constants::syntax_type syntax_type(charT c)const
572 return m_pimpl->syntax_type(c);
574 regex_constants::escape_syntax_type escape_syntax_type(charT c) const
576 return m_pimpl->escape_syntax_type(c);
578 charT translate(charT c) const
582 charT translate_nocase(charT c) const
584 return this->m_pimpl->tolower(c);
586 charT translate(charT c, bool icase) const
588 return icase ? this->m_pimpl->tolower(c) : c;
590 charT tolower(charT c) const
592 return this->m_pimpl->tolower(c);
594 charT toupper(charT c) const
596 return ::boost::re_detail::w32_toupper(c, this->m_pimpl->m_locale);
598 string_type transform(const charT* p1, const charT* p2) const
600 return ::boost::re_detail::w32_transform(this->m_pimpl->m_locale, p1, p2);
602 string_type transform_primary(const charT* p1, const charT* p2) const
604 return m_pimpl->transform_primary(p1, p2);
606 char_class_type lookup_classname(const charT* p1, const charT* p2) const
608 return m_pimpl->lookup_classname(p1, p2);
610 string_type lookup_collatename(const charT* p1, const charT* p2) const
612 return m_pimpl->lookup_collatename(p1, p2);
614 bool isctype(charT c, char_class_type f) const
616 if((f & re_detail::w32_regex_traits_implementation<charT>::mask_base)
617 && (this->m_pimpl->isctype(f & re_detail::w32_regex_traits_implementation<charT>::mask_base, c)))
619 else if((f & re_detail::w32_regex_traits_implementation<charT>::mask_unicode) && re_detail::is_extended(c))
621 else if((f & re_detail::w32_regex_traits_implementation<charT>::mask_word) && (c == '_'))
625 int toi(const charT*& p1, const charT* p2, int radix)const
627 return ::boost::re_detail::global_toi(p1, p2, radix, *this);
629 int value(charT c, int radix)const
631 int result = ::boost::re_detail::global_value(c);
632 return result < radix ? result : -1;
634 locale_type imbue(locale_type l)
636 ::boost::re_detail::lcid_type result(getloc());
637 m_pimpl = re_detail::create_w32_regex_traits<charT>(l);
640 locale_type getloc()const
642 return m_pimpl->m_locale;
644 std::string error_string(regex_constants::error_type n) const
646 return m_pimpl->error_string(n);
651 // set the name of the message catalog in use (defaults to "boost_regex").
653 static std::string catalog_name(const std::string& name);
654 static std::string get_catalog_name();
657 boost::shared_ptr<const re_detail::w32_regex_traits_implementation<charT> > m_pimpl;
659 // catalog name handler:
661 static std::string& get_catalog_name_inst();
663 #ifdef BOOST_HAS_THREADS
664 static static_mutex& get_mutex_inst();
668 template <class charT>
669 std::string w32_regex_traits<charT>::catalog_name(const std::string& name)
671 #ifdef BOOST_HAS_THREADS
672 static_mutex::scoped_lock lk(get_mutex_inst());
674 std::string result(get_catalog_name_inst());
675 get_catalog_name_inst() = name;
679 template <class charT>
680 std::string& w32_regex_traits<charT>::get_catalog_name_inst()
682 static std::string s_name;
686 template <class charT>
687 std::string w32_regex_traits<charT>::get_catalog_name()
689 #ifdef BOOST_HAS_THREADS
690 static_mutex::scoped_lock lk(get_mutex_inst());
692 std::string result(get_catalog_name_inst());
696 #ifdef BOOST_HAS_THREADS
697 template <class charT>
698 static_mutex& w32_regex_traits<charT>::get_mutex_inst()
700 static static_mutex s_mutex = BOOST_STATIC_MUTEX_INIT;
712 #ifdef BOOST_HAS_ABI_HEADERS
713 # include BOOST_ABI_SUFFIX