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>
40 #pragma warning(disable: 4103)
42 #ifdef BOOST_HAS_ABI_HEADERS
43 # include BOOST_ABI_PREFIX
51 #pragma warning(disable:4786)
52 #pragma warning(disable:4800)
58 // forward declaration is needed by some compilers:
60 template <class charT>
61 class w32_regex_traits;
66 // start by typedeffing the types we'll need:
68 typedef ::boost::uint32_t lcid_type; // placeholder for LCID.
69 typedef ::boost::shared_ptr<void> cat_type; // placeholder for dll HANDLE.
72 // then add wrappers around the actual Win32 API's (ie implementation hiding):
74 BOOST_REGEX_DECL lcid_type BOOST_REGEX_CALL w32_get_default_locale();
75 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_lower(char, lcid_type);
76 #ifndef BOOST_NO_WREGEX
77 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_lower(wchar_t, lcid_type);
78 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
79 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_lower(unsigned short ca, lcid_type state_id);
82 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_upper(char, lcid_type);
83 #ifndef BOOST_NO_WREGEX
84 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_upper(wchar_t, lcid_type);
85 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
86 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is_upper(unsigned short ca, lcid_type state_id);
89 BOOST_REGEX_DECL cat_type BOOST_REGEX_CALL w32_cat_open(const std::string& name);
90 BOOST_REGEX_DECL std::string BOOST_REGEX_CALL w32_cat_get(const cat_type& cat, lcid_type state_id, int i, const std::string& def);
91 #ifndef BOOST_NO_WREGEX
92 BOOST_REGEX_DECL std::wstring BOOST_REGEX_CALL w32_cat_get(const cat_type& cat, lcid_type state_id, int i, const std::wstring& def);
93 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
94 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);
97 BOOST_REGEX_DECL std::string BOOST_REGEX_CALL w32_transform(lcid_type state_id, const char* p1, const char* p2);
98 #ifndef BOOST_NO_WREGEX
99 BOOST_REGEX_DECL std::wstring BOOST_REGEX_CALL w32_transform(lcid_type state_id, const wchar_t* p1, const wchar_t* p2);
100 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
101 BOOST_REGEX_DECL std::basic_string<unsigned short> BOOST_REGEX_CALL w32_transform(lcid_type state_id, const unsigned short* p1, const unsigned short* p2);
104 BOOST_REGEX_DECL char BOOST_REGEX_CALL w32_tolower(char c, lcid_type);
105 #ifndef BOOST_NO_WREGEX
106 BOOST_REGEX_DECL wchar_t BOOST_REGEX_CALL w32_tolower(wchar_t c, lcid_type);
107 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
108 BOOST_REGEX_DECL unsigned short BOOST_REGEX_CALL w32_tolower(unsigned short c, lcid_type state_id);
111 BOOST_REGEX_DECL char BOOST_REGEX_CALL w32_toupper(char c, lcid_type);
112 #ifndef BOOST_NO_WREGEX
113 BOOST_REGEX_DECL wchar_t BOOST_REGEX_CALL w32_toupper(wchar_t c, lcid_type);
115 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is(lcid_type, boost::uint32_t mask, char c);
116 #ifndef BOOST_NO_WREGEX
117 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is(lcid_type, boost::uint32_t mask, wchar_t c);
118 #ifdef BOOST_REGEX_HAS_OTHER_WCHAR_T
119 BOOST_REGEX_DECL bool BOOST_REGEX_CALL w32_is(lcid_type state_id, boost::uint32_t m, unsigned short c);
123 // class w32_regex_traits_base:
124 // acts as a container for locale and the facets we are using.
126 template <class charT>
127 struct w32_regex_traits_base
129 w32_regex_traits_base(lcid_type l)
131 lcid_type imbue(lcid_type l);
136 template <class charT>
137 inline lcid_type w32_regex_traits_base<charT>::imbue(lcid_type l)
139 lcid_type result(m_locale);
145 // class w32_regex_traits_char_layer:
146 // implements methods that require specialisation for narrow characters:
148 template <class charT>
149 class w32_regex_traits_char_layer : public w32_regex_traits_base<charT>
151 typedef std::basic_string<charT> string_type;
152 typedef std::map<charT, regex_constants::syntax_type> map_type;
153 typedef typename map_type::const_iterator map_iterator_type;
155 w32_regex_traits_char_layer(const lcid_type l);
157 regex_constants::syntax_type syntax_type(charT c)const
159 map_iterator_type i = m_char_map.find(c);
160 return ((i == m_char_map.end()) ? 0 : i->second);
162 regex_constants::escape_syntax_type escape_syntax_type(charT c) const
164 map_iterator_type i = m_char_map.find(c);
165 if(i == m_char_map.end())
167 if(::boost::re_detail::w32_is_lower(c, this->m_locale)) return regex_constants::escape_type_class;
168 if(::boost::re_detail::w32_is_upper(c, this->m_locale)) return regex_constants::escape_type_not_class;
173 charT tolower(charT c)const
175 return ::boost::re_detail::w32_tolower(c, this->m_locale);
177 bool isctype(boost::uint32_t mask, charT c)const
179 return ::boost::re_detail::w32_is(this->m_locale, mask, c);
183 string_type get_default_message(regex_constants::syntax_type);
184 // TODO: use a hash table when available!
188 template <class charT>
189 w32_regex_traits_char_layer<charT>::w32_regex_traits_char_layer(::boost::re_detail::lcid_type l)
190 : w32_regex_traits_base<charT>(l)
192 // we need to start by initialising our syntax map so we know which
193 // character is used for which purpose:
195 std::string cat_name(w32_regex_traits<charT>::get_catalog_name());
198 cat = ::boost::re_detail::w32_cat_open(cat_name);
201 std::string m("Unable to open message catalog: ");
202 std::runtime_error err(m + cat_name);
203 boost::re_detail::raise_runtime_error(err);
207 // if we have a valid catalog then load our messages:
211 for(regex_constants::syntax_type i = 1; i < regex_constants::syntax_max; ++i)
213 string_type mss = ::boost::re_detail::w32_cat_get(cat, this->m_locale, i, get_default_message(i));
214 for(typename string_type::size_type j = 0; j < mss.size(); ++j)
216 this->m_char_map[mss[j]] = i;
222 for(regex_constants::syntax_type i = 1; i < regex_constants::syntax_max; ++i)
224 const char* ptr = get_default_syntax(i);
227 this->m_char_map[static_cast<charT>(*ptr)] = i;
234 template <class charT>
235 typename w32_regex_traits_char_layer<charT>::string_type
236 w32_regex_traits_char_layer<charT>::get_default_message(regex_constants::syntax_type i)
238 const char* ptr = get_default_syntax(i);
242 result.append(1, static_cast<charT>(*ptr));
249 // specialised version for narrow characters:
252 class BOOST_REGEX_DECL w32_regex_traits_char_layer<char> : public w32_regex_traits_base<char>
254 typedef std::string string_type;
256 w32_regex_traits_char_layer(::boost::re_detail::lcid_type l)
257 : w32_regex_traits_base<char>(l)
262 regex_constants::syntax_type syntax_type(char c)const
264 return m_char_map[static_cast<unsigned char>(c)];
266 regex_constants::escape_syntax_type escape_syntax_type(char c) const
268 return m_char_map[static_cast<unsigned char>(c)];
270 char tolower(char c)const
272 return m_lower_map[static_cast<unsigned char>(c)];
274 bool isctype(boost::uint32_t mask, char c)const
276 return m_type_map[static_cast<unsigned char>(c)] & mask;
280 regex_constants::syntax_type m_char_map[1u << CHAR_BIT];
281 char m_lower_map[1u << CHAR_BIT];
282 boost::uint16_t m_type_map[1u << CHAR_BIT];
287 // class w32_regex_traits_implementation:
288 // provides pimpl implementation for w32_regex_traits.
290 template <class charT>
291 class w32_regex_traits_implementation : public w32_regex_traits_char_layer<charT>
294 typedef typename w32_regex_traits<charT>::char_class_type char_class_type;
295 BOOST_STATIC_CONSTANT(char_class_type, mask_word = 0x0400); // must be C1_DEFINED << 1
296 BOOST_STATIC_CONSTANT(char_class_type, mask_unicode = 0x0800); // must be C1_DEFINED << 2
297 BOOST_STATIC_CONSTANT(char_class_type, mask_horizontal = 0x1000); // must be C1_DEFINED << 3
298 BOOST_STATIC_CONSTANT(char_class_type, mask_vertical = 0x2000); // must be C1_DEFINED << 4
299 BOOST_STATIC_CONSTANT(char_class_type, mask_base = 0x3ff); // all the masks used by the CT_CTYPE1 group
301 typedef std::basic_string<charT> string_type;
302 typedef charT char_type;
303 w32_regex_traits_implementation(::boost::re_detail::lcid_type l);
304 std::string error_string(regex_constants::error_type n) const
306 if(!m_error_strings.empty())
308 std::map<int, std::string>::const_iterator p = m_error_strings.find(n);
309 return (p == m_error_strings.end()) ? std::string(get_default_error_string(n)) : p->second;
311 return get_default_error_string(n);
313 char_class_type lookup_classname(const charT* p1, const charT* p2) const
315 char_class_type result = lookup_classname_imp(p1, p2);
318 typedef typename string_type::size_type size_type;
319 string_type temp(p1, p2);
320 for(size_type i = 0; i < temp.size(); ++i)
321 temp[i] = this->tolower(temp[i]);
322 result = lookup_classname_imp(&*temp.begin(), &*temp.begin() + temp.size());
326 string_type lookup_collatename(const charT* p1, const charT* p2) const;
327 string_type transform_primary(const charT* p1, const charT* p2) const;
328 string_type transform(const charT* p1, const charT* p2) const
330 return ::boost::re_detail::w32_transform(this->m_locale, p1, p2);
333 std::map<int, std::string> m_error_strings; // error messages indexed by numberic ID
334 std::map<string_type, char_class_type> m_custom_class_names; // character class names
335 std::map<string_type, string_type> m_custom_collate_names; // collating element names
336 unsigned m_collate_type; // the form of the collation string
337 charT m_collate_delim; // the collation group delimiter
341 char_class_type lookup_classname_imp(const charT* p1, const charT* p2) const;
344 template <class charT>
345 typename w32_regex_traits_implementation<charT>::string_type
346 w32_regex_traits_implementation<charT>::transform_primary(const charT* p1, const charT* p2) const
350 // What we do here depends upon the format of the sort key returned by
351 // sort key returned by this->transform:
353 switch(m_collate_type)
357 // the best we can do is translate to lower case, then get a regular sort key:
359 result.assign(p1, p2);
360 typedef typename string_type::size_type size_type;
361 for(size_type i = 0; i < result.size(); ++i)
362 result[i] = this->tolower(result[i]);
363 result = this->transform(&*result.begin(), &*result.begin() + result.size());
368 // get a regular sort key, and then truncate it:
369 result.assign(this->transform(p1, p2));
370 result.erase(this->m_collate_delim);
374 // get a regular sort key, and then truncate everything after the delim:
375 result.assign(this->transform(p1, p2));
377 for(i = 0; i < result.size(); ++i)
379 if(result[i] == m_collate_delim)
386 result = string_type(1, charT(0));
390 template <class charT>
391 typename w32_regex_traits_implementation<charT>::string_type
392 w32_regex_traits_implementation<charT>::lookup_collatename(const charT* p1, const charT* p2) const
394 typedef typename std::map<string_type, string_type>::const_iterator iter_type;
395 if(m_custom_collate_names.size())
397 iter_type pos = m_custom_collate_names.find(string_type(p1, p2));
398 if(pos != m_custom_collate_names.end())
401 #if !defined(BOOST_NO_TEMPLATED_ITERATOR_CONSTRUCTORS)\
402 && !BOOST_WORKAROUND(BOOST_MSVC, < 1300)\
403 && !BOOST_WORKAROUND(__BORLANDC__, <= 0x0551)
404 std::string name(p1, p2);
407 const charT* p0 = p1;
409 name.append(1, char(*p0++));
411 name = lookup_default_collate_name(name);
412 #if !defined(BOOST_NO_TEMPLATED_ITERATOR_CONSTRUCTORS)\
413 && !BOOST_WORKAROUND(BOOST_MSVC, < 1300)\
414 && !BOOST_WORKAROUND(__BORLANDC__, <= 0x0551)
416 return string_type(name.begin(), name.end());
421 typedef std::string::const_iterator iter;
422 iter b = name.begin();
425 result.append(1, charT(*b++));
430 return string_type(1, *p1);
431 return string_type();
434 template <class charT>
435 w32_regex_traits_implementation<charT>::w32_regex_traits_implementation(::boost::re_detail::lcid_type l)
436 : w32_regex_traits_char_layer<charT>(l)
439 std::string cat_name(w32_regex_traits<charT>::get_catalog_name());
442 cat = ::boost::re_detail::w32_cat_open(cat_name);
445 std::string m("Unable to open message catalog: ");
446 std::runtime_error err(m + cat_name);
447 boost::re_detail::raise_runtime_error(err);
451 // if we have a valid catalog then load our messages:
458 for(boost::regex_constants::error_type i = static_cast<boost::regex_constants::error_type>(0);
459 i <= boost::regex_constants::error_unknown;
460 i = static_cast<boost::regex_constants::error_type>(i + 1))
462 const char* p = get_default_error_string(i);
463 string_type default_message;
466 default_message.append(1, static_cast<charT>(*p));
469 string_type s = ::boost::re_detail::w32_cat_get(cat, this->m_locale, i+200, default_message);
471 for(std::string::size_type j = 0; j < s.size(); ++j)
473 result.append(1, static_cast<char>(s[j]));
475 m_error_strings[i] = result;
478 // Custom class names:
480 static const char_class_type masks[14] =
482 0x0104u, // C1_ALPHA | C1_DIGIT
486 (~(0x0020u|0x0008u) & 0x01ffu) | 0x0400u, // not C1_CNTRL or C1_SPACE
488 (~0x0020u & 0x01ffu) | 0x0400, // not C1_CNTRL
492 0x0080u, // C1_XDIGIT
494 w32_regex_traits_implementation<charT>::mask_word,
495 w32_regex_traits_implementation<charT>::mask_unicode,
497 static const string_type null_string;
498 for(unsigned int j = 0; j <= 13; ++j)
500 string_type s(::boost::re_detail::w32_cat_get(cat, this->m_locale, j+300, null_string));
502 this->m_custom_class_names[s] = masks[j];
506 // get the collation format used by m_pcollate:
508 m_collate_type = re_detail::find_sort_syntax(this, &m_collate_delim);
511 template <class charT>
512 typename w32_regex_traits_implementation<charT>::char_class_type
513 w32_regex_traits_implementation<charT>::lookup_classname_imp(const charT* p1, const charT* p2) const
515 static const char_class_type masks[22] =
518 0x0104u, // C1_ALPHA | C1_DIGIT
524 (~(0x0020u|0x0008u|0x0040) & 0x01ffu) | 0x0400u, // not C1_CNTRL or C1_SPACE or C1_BLANK
525 w32_regex_traits_implementation<charT>::mask_horizontal,
528 (~0x0020u & 0x01ffu) | 0x0400, // not C1_CNTRL
533 w32_regex_traits_implementation<charT>::mask_unicode,
535 w32_regex_traits_implementation<charT>::mask_vertical,
536 0x0104u | w32_regex_traits_implementation<charT>::mask_word,
537 0x0104u | w32_regex_traits_implementation<charT>::mask_word,
538 0x0080u, // C1_XDIGIT
540 if(m_custom_class_names.size())
542 typedef typename std::map<std::basic_string<charT>, char_class_type>::const_iterator map_iter;
543 map_iter pos = m_custom_class_names.find(string_type(p1, p2));
544 if(pos != m_custom_class_names.end())
547 std::size_t state_id = 1 + re_detail::get_default_class_id(p1, p2);
548 if(state_id < sizeof(masks) / sizeof(masks[0]))
549 return masks[state_id];
554 template <class charT>
555 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))
557 // TODO: create a cache for previously constructed objects.
558 return boost::object_cache< ::boost::re_detail::lcid_type, w32_regex_traits_implementation<charT> >::get(l, 5);
563 template <class charT>
564 class w32_regex_traits
567 typedef charT char_type;
568 typedef std::size_t size_type;
569 typedef std::basic_string<char_type> string_type;
570 typedef ::boost::re_detail::lcid_type locale_type;
571 typedef boost::uint_least32_t char_class_type;
573 struct boost_extensions_tag{};
576 : m_pimpl(re_detail::create_w32_regex_traits<charT>(::boost::re_detail::w32_get_default_locale()))
578 static size_type length(const char_type* p)
580 return std::char_traits<charT>::length(p);
582 regex_constants::syntax_type syntax_type(charT c)const
584 return m_pimpl->syntax_type(c);
586 regex_constants::escape_syntax_type escape_syntax_type(charT c) const
588 return m_pimpl->escape_syntax_type(c);
590 charT translate(charT c) const
594 charT translate_nocase(charT c) const
596 return this->m_pimpl->tolower(c);
598 charT translate(charT c, bool icase) const
600 return icase ? this->m_pimpl->tolower(c) : c;
602 charT tolower(charT c) const
604 return this->m_pimpl->tolower(c);
606 charT toupper(charT c) const
608 return ::boost::re_detail::w32_toupper(c, this->m_pimpl->m_locale);
610 string_type transform(const charT* p1, const charT* p2) const
612 return ::boost::re_detail::w32_transform(this->m_pimpl->m_locale, p1, p2);
614 string_type transform_primary(const charT* p1, const charT* p2) const
616 return m_pimpl->transform_primary(p1, p2);
618 char_class_type lookup_classname(const charT* p1, const charT* p2) const
620 return m_pimpl->lookup_classname(p1, p2);
622 string_type lookup_collatename(const charT* p1, const charT* p2) const
624 return m_pimpl->lookup_collatename(p1, p2);
626 bool isctype(charT c, char_class_type f) const
628 if((f & re_detail::w32_regex_traits_implementation<charT>::mask_base)
629 && (this->m_pimpl->isctype(f & re_detail::w32_regex_traits_implementation<charT>::mask_base, c)))
631 else if((f & re_detail::w32_regex_traits_implementation<charT>::mask_unicode) && re_detail::is_extended(c))
633 else if((f & re_detail::w32_regex_traits_implementation<charT>::mask_word) && (c == '_'))
635 else if((f & re_detail::w32_regex_traits_implementation<charT>::mask_vertical)
636 && (::boost::re_detail::is_separator(c) || (c == '\v')))
638 else if((f & re_detail::w32_regex_traits_implementation<charT>::mask_horizontal)
639 && this->isctype(c, 0x0008u) && !this->isctype(c, re_detail::w32_regex_traits_implementation<charT>::mask_vertical))
643 int toi(const charT*& p1, const charT* p2, int radix)const
645 return ::boost::re_detail::global_toi(p1, p2, radix, *this);
647 int value(charT c, int radix)const
649 int result = ::boost::re_detail::global_value(c);
650 return result < radix ? result : -1;
652 locale_type imbue(locale_type l)
654 ::boost::re_detail::lcid_type result(getloc());
655 m_pimpl = re_detail::create_w32_regex_traits<charT>(l);
658 locale_type getloc()const
660 return m_pimpl->m_locale;
662 std::string error_string(regex_constants::error_type n) const
664 return m_pimpl->error_string(n);
669 // set the name of the message catalog in use (defaults to "boost_regex").
671 static std::string catalog_name(const std::string& name);
672 static std::string get_catalog_name();
675 boost::shared_ptr<const re_detail::w32_regex_traits_implementation<charT> > m_pimpl;
677 // catalog name handler:
679 static std::string& get_catalog_name_inst();
681 #ifdef BOOST_HAS_THREADS
682 static static_mutex& get_mutex_inst();
686 template <class charT>
687 std::string w32_regex_traits<charT>::catalog_name(const std::string& name)
689 #ifdef BOOST_HAS_THREADS
690 static_mutex::scoped_lock lk(get_mutex_inst());
692 std::string result(get_catalog_name_inst());
693 get_catalog_name_inst() = name;
697 template <class charT>
698 std::string& w32_regex_traits<charT>::get_catalog_name_inst()
700 static std::string s_name;
704 template <class charT>
705 std::string w32_regex_traits<charT>::get_catalog_name()
707 #ifdef BOOST_HAS_THREADS
708 static_mutex::scoped_lock lk(get_mutex_inst());
710 std::string result(get_catalog_name_inst());
714 #ifdef BOOST_HAS_THREADS
715 template <class charT>
716 static_mutex& w32_regex_traits<charT>::get_mutex_inst()
718 static static_mutex s_mutex = BOOST_STATIC_MUTEX_INIT;
731 #pragma warning(push)
732 #pragma warning(disable: 4103)
734 #ifdef BOOST_HAS_ABI_HEADERS
735 # include BOOST_ABI_SUFFIX