lluistring.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:5k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lluistring.h
  3.  * @author: Steve Bennetts
  4.  * @brief A fancy wrapper for std::string supporting argument substitutions.
  5.  *
  6.  * $LicenseInfo:firstyear=2006&license=viewergpl$
  7.  * 
  8.  * Copyright (c) 2006-2010, Linden Research, Inc.
  9.  * 
  10.  * Second Life Viewer Source Code
  11.  * The source code in this file ("Source Code") is provided by Linden Lab
  12.  * to you under the terms of the GNU General Public License, version 2.0
  13.  * ("GPL"), unless you have obtained a separate licensing agreement
  14.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  15.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  16.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  17.  * 
  18.  * There are special exceptions to the terms and conditions of the GPL as
  19.  * it is applied to this Source Code. View the full text of the exception
  20.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  21.  * online at
  22.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  23.  * 
  24.  * By copying, modifying or distributing this software, you acknowledge
  25.  * that you have read and understood your obligations described above,
  26.  * and agree to abide by those obligations.
  27.  * 
  28.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  29.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  30.  * COMPLETENESS OR PERFORMANCE.
  31.  * $/LicenseInfo$
  32.  */
  33. #ifndef LL_LLUISTRING_H
  34. #define LL_LLUISTRING_H
  35. #include "llstring.h"
  36. #include <string>
  37. // Use this class to store translated text that may have arguments
  38. // e.g. "Welcome [USERNAME] to [SECONDLIFE]!"
  39. // Adding or changing an argument will update the result string, preserving the origianl
  40. // Thus, subsequent changes to arguments or even the original string will produce
  41. //  the correct result
  42. // Example Usage:
  43. // LLUIString mMessage("Welcome [USERNAME] to [SECONDLIFE]!");
  44. // mMessage.setArg("[USERNAME]", "Steve");
  45. // mMessage.setArg("[SECONDLIFE]", "Second Life");
  46. // llinfos << mMessage.getString() << llendl; // outputs "Welcome Steve to Second Life"
  47. // mMessage.setArg("[USERNAME]", "Joe");
  48. // llinfos << mMessage.getString() << llendl; // outputs "Welcome Joe to Second Life"
  49. // mMessage = "Bienvenido a la [SECONDLIFE] [USERNAME]"
  50. // mMessage.setArg("[SECONDLIFE]", "Segunda Vida");
  51. // llinfos << mMessage.getString() << llendl; // outputs "Bienvenido a la Segunda Vida Joe"
  52. // Implementation Notes:
  53. // Attempting to have operator[](const std::string& s) return mArgs[s] fails because we have
  54. // to call format() after the assignment happens.
  55. class LLUIString
  56. {
  57. public:
  58. // These methods all perform appropriate argument substitution
  59. // and modify mOrig where appropriate
  60.         LLUIString() : mNeedsResult(false), mNeedsWResult(false) {}
  61. LLUIString(const std::string& instring, const LLStringUtil::format_map_t& args);
  62. LLUIString(const std::string& instring) { assign(instring); }
  63. void assign(const std::string& instring);
  64. LLUIString& operator=(const std::string& s) { assign(s); return *this; }
  65. void setArgList(const LLStringUtil::format_map_t& args);
  66. void setArgs(const LLStringUtil::format_map_t& args) { setArgList(args); }
  67. void setArgs(const class LLSD& sd);
  68. void setArg(const std::string& key, const std::string& replacement);
  69. const std::string& getString() const { return getUpdatedResult(); }
  70. operator std::string() const { return getUpdatedResult(); }
  71. const LLWString& getWString() const { return getUpdatedWResult(); }
  72. operator LLWString() const { return getUpdatedWResult(); }
  73. bool empty() const { return getUpdatedResult().empty(); }
  74. S32 length() const { return getUpdatedWResult().size(); }
  75. void clear();
  76. void clearArgs() { mArgs.clear(); }
  77. // These utility functions are included for text editing.
  78. // They do not affect mOrig and do not perform argument substitution
  79. void truncate(S32 maxchars);
  80. void erase(S32 charidx, S32 len);
  81. void insert(S32 charidx, const LLWString& wchars);
  82. void replace(S32 charidx, llwchar wc);
  83. private:
  84. // something changed, requiring reformatting of strings
  85. void dirty();
  86. std::string& getUpdatedResult() const { if (mNeedsResult) { updateResult(); } return mResult; }
  87. LLWString& getUpdatedWResult() const{ if (mNeedsWResult) { updateWResult(); } return mWResult; }
  88. // do actual work of updating strings (non-inlined)
  89. void updateResult() const;
  90. void updateWResult() const;
  91. std::string mOrig;
  92. mutable std::string mResult;
  93. mutable LLWString mWResult; // for displaying
  94. LLStringUtil::format_map_t mArgs;
  95. // controls lazy evaluation
  96. mutable bool mNeedsResult;
  97. mutable bool mNeedsWResult;
  98. };
  99. #endif // LL_LLUISTRING_H