intl/strres/nsStringBundle.h
author Ting-Yu Lin <tlin@mozilla.com>
Mon, 11 May 2015 02:17:00 +0800
changeset 243636 33a09170386b045838d52218e1c9b13856b4b7cc
parent 234933 ac4464790ec4896a5188fa50cfc69ae0ffeddc08
child 368809 129793760f2d718ed61ba17d9aacd57c7ec6785b
permissions -rw-r--r--
Bug 1163490 - Remove SpecialPowers from marionette carets test. r=jgriffin

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsStringBundle_h__
#define nsStringBundle_h__

#include "mozilla/ReentrantMonitor.h"
#include "nsIStringBundle.h"
#include "nsCOMPtr.h"
#include "nsString.h"
#include "nsCOMArray.h"

class nsIPersistentProperties;
class nsIStringBundleOverride;

class nsStringBundle : public nsIStringBundle
{
public:
    // init version
    nsStringBundle(const char* aURLSpec, nsIStringBundleOverride*);
    nsresult LoadProperties();

    NS_DECL_THREADSAFE_ISUPPORTS
    NS_DECL_NSISTRINGBUNDLE

    nsCOMPtr<nsIPersistentProperties> mProps;

protected:
    virtual ~nsStringBundle();

    //
    // functional decomposition of the funitions repeatively called
    //
    nsresult GetStringFromID(int32_t aID, nsAString& aResult);
    nsresult GetStringFromName(const nsAString& aName, nsAString& aResult);

    nsresult GetCombinedEnumeration(nsIStringBundleOverride* aOverrideString,
                                    nsISimpleEnumerator** aResult);
private:
    nsCString              mPropertiesURL;
    nsCOMPtr<nsIStringBundleOverride> mOverrideStrings;
    mozilla::ReentrantMonitor    mReentrantMonitor;
    bool                         mAttemptedLoad;
    bool                         mLoaded;

public:
    static nsresult FormatString(const char16_t *formatStr,
                                 const char16_t **aParams, uint32_t aLength,
                                 char16_t **aResult);
};

class nsExtensibleStringBundle;

/**
 * An extensible implementation of the StringBundle interface.
 *
 * @created         28/Dec/1999
 * @author  Catalin Rotaru [CATA]
 */
class nsExtensibleStringBundle final : public nsIStringBundle
{
  NS_DECL_ISUPPORTS
  NS_DECL_NSISTRINGBUNDLE

  nsresult Init(const char * aCategory, nsIStringBundleService *);

public:
  nsExtensibleStringBundle();

private:
  virtual ~nsExtensibleStringBundle();

  nsCOMArray<nsIStringBundle> mBundles;
  bool mLoaded;
};



#endif