The new nsString class implementation (1999)

正当化

nsString クラスは、デフォルトのインプリメンテーションとして Gecko (とその他のモジュール) のすべてを通して使われる wide character の文字列です。しかし、処理すべきインプリメンテーションの細部がいくつかある、という問題を抱えており、それはこのドキュメントの主題でもあります。現在のインプリメントで欠けているものは、

1. クラスの基本的問題 -- もろさのために、複数の DLL にまたがった使用ができない
2. 内在する国際化サポートの不足
3. 効率が低い、特に narrow (1 バイト) character 文字列サポートがない
4. 外部メモリ管理方針をサポートしないこと
5. XPCOM インタフェースの欠如

新しい nsStrImpl インプリメンテーションの顕著な特徴は

1. 1 バイトと 2 バイトのサイズの character の内在的なサポート
2. 異なった character サイズの間の自動的な変換の提供
3. 耐久性のある基本構造がクラスの脆さの問題を減らす: DLL の垣根をこえても安全
4. nsStrImpl を操作するための C スタイルの関数の提供
5. メモリ方針に特化した単純なメモリ割り当て API の提供
6. BString とのバイナリフォーマットの共有
7. もうすぐ実装予定：新しい XPCOM (nsIString) インタフェース
8. テンプレート化されていない: これは Gecko のために必要です。
9. とても効率的なバッファ操作

構造

新しい構造の基礎となるデータタイプは、以下に示す struct nsStrImpl です。

struct nsStrImpl {
  PRInt32 mLength;
  void*   mBuffer;
  PRInt32 mCapacity;
  char    mCharSize;
  char    mUnused;

  // そして今は、nsStrImpl API のための...
  static void EnsureCapacity(nsStrImpl& aString,PRUint32 aNewLength);
  static void GrowCapacity(nsStrImpl& aString,PRUint32 aNewLength);

  static void Append(nsStrImpl& aDest,const nsStrImpl& aSource,PRUint32 anOffset,PRInt32 aCount);
  static void AppendCString(nsStrImpl& aDest,const char* aSource,PRUint32 anOffset,PRInt32 aCount);

  static void Assign(nsStrImpl& aDest,const nsStrImpl& aSource,PRUint32 anOffset,PRInt32 aCount);
  static void AssignCString(nsStrImpl& aDest,const char* aSource,PRUint32 anOffset,PRInt32 aCount);

  // char もしくは、既存文字列の部分の代入...
  static void Insert(nsStrImpl& aDest,PRUint32 aDestOffset,
                     const nsStrImpl& aSource,PRUint32 aSrcOffset,PRInt32 aCount);

  static void InsertCString(nsStrImpl& aDest,PRUint32 aDestOffset,
                            const char* aSource,PRUint32 aSrcOffset,PRInt32 aCount);

  static void InsertChar(nsStrImpl& aDest,PRUint32 aDestOffset,char theChar);
  static void InsertChar(nsStrImpl& aDest,PRUint32 aDestOffset,PRUnichar theUnichar);
  static void InsertChar(nsStrImpl& aDest,PRUint32 aDestOffset,PRInt32 theQuadChar);

  static void Delete(nsStrImpl& aDest,PRUint32 aDestOffset,PRUint32 aCount);
  static void Truncate(nsStrImpl& aDest,PRUint32 aDestOffset);

  static PRInt32 Compare(const nsStrImpl& aDest,const nsStrImpl& aSource,
                         PRInt32 aCount,PRBool aIgnoreCase);
};

使用パターン

メモリ管理

新しい構造の主要な機能拡張は、差込可能なメモリアロケータです。すべての nsString のサブクラスは、自身のデフォルトのアロケートのインプリメンテーションを提供しています。しかし、プログラマがそれを使うかどうかは自由です。新しいプロトタイプ nsStrImpl、nsString クラスでは、アロケータは文字列の構築の間に組み込まれる備えつけのメンバです (デフォルトでグローバルのアロケータに共有されます)。

メモ: COM ルールはだれでも同じアロケータを使う必要があることを意味します。そのアロケータは CoGetMalloc() と呼ばれるグローバル COM サービス経由で取得します。プログラマは彼ら自身の方針を組み込むことができるため、私たちの nsStrImpl はアロケータパターンを使います。しかし、これはマルチプロセス環境でアロケーションをシンプルにもします。 string がそれ自身の (共有の) アロケータをこの目的で返すことができることがすなわち十分であるかどうか疑っています。

私たちの最小限の nsIMemoryAgent インタフェースはちょうど nsString の慣習をサポートするのに十分であり、一般的メモリアロケーション慣習を提供するように拡張されるでしょう。これがその API です。

class nsIMemoryAgent : nsISupports {
  void* New(nsInt32 aSize)=0;  // alloc と realloc 両方のために使われます
  void* Delete(void* aPtr)=0;
};