File: nsIStringBundle.idl

package info (click to toggle)
firefox 147.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,532 kB
  • sloc: cpp: 7,607,356; javascript: 6,533,348; ansic: 3,775,236; python: 1,415,508; xml: 634,561; asm: 438,949; java: 186,241; sh: 62,760; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (91 lines) | stat: -rw-r--r-- 3,302 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */

#include "nsISupports.idl"
#include "nsISimpleEnumerator.idl"

%{C++
#include "mozilla/MemoryReporting.h"
#include "mozilla/ipc/SharedMemoryHandle.h"

namespace mozilla {
namespace dom {
class ContentParent;
}
}

// Define Contractid and CID
// {D85A17C1-AA7C-11d2-9B8C-00805F8A16D9}
#define NS_STRINGBUNDLESERVICE_CID \
{ 0xd85a17c1, 0xaa7c, 0x11d2, \
  { 0x9b, 0x8c, 0x0, 0x80, 0x5f, 0x8a, 0x16, 0xd9 } }

#define NS_STRINGBUNDLE_CONTRACTID "@mozilla.org/intl/stringbundle;1"

%}

[ptr] native ContentParent(mozilla::dom::ContentParent);
native ReadOnlySharedMemoryHandle(mozilla::ipc::ReadOnlySharedMemoryHandle&&);
native MallocSizeOf(mozilla::MallocSizeOf);

[scriptable, builtinclass, uuid(D85A17C2-AA7C-11d2-9B8C-00805F8A16D9)]
interface nsIStringBundle : nsISupports
{
  AString GetStringFromID(in long aID);

  // This method is mostly used from JS, where AUTF8String is appropriate.
  [binaryname(GetStringFromAUTF8Name)]
  AString GetStringFromName(in AUTF8String aName);

  // This method is mostly used from C++, where |string| is appropriate because
  // the names are most often 8-bit string literals (normally ASCII, though
  // u8"foo" literals will also work).
  [noscript, binaryname(GetStringFromName)]
  AString GetStringFromNameCpp(in string aName);

  // This method is mostly used from JS, where AUTF8String is appropriate.
  [binaryname(FormatStringFromAUTF8Name)]
  AString formatStringFromName(in AUTF8String aName, in Array<AString> params);

  // This method is mostly used from C++, where |string| is appropriate because
  // the names are most often 8-bit string literals (normally ASCII, though
  // u8"foo" literals will also work).
  [noscript, binaryname(FormatStringFromName)]
  AString formatStringFromNameCpp(in string aName, in Array<AString> params);

  /*
  Implements nsISimpleEnumerator, replaces nsIEnumerator
  */
  nsISimpleEnumerator getSimpleEnumeration();
  // Preloads string bundle data asynchronously
  void asyncPreload();

  [notxpcom, nostdcall] size_t SizeOfIncludingThis(in MallocSizeOf aMallocSizeOf);
  [notxpcom, nostdcall] size_t SizeOfIncludingThisIfUnshared(in MallocSizeOf aMallocSizeOf);
};

[scriptable, builtinclass, uuid(D85A17C0-AA7C-11d2-9B8C-00805F8A16D9)]
interface nsIStringBundleService : nsISupports
{
  nsIStringBundle createBundle(in string aURLSpec);

  /**
   * flushes the string bundle cache - useful when the locale changes or
   * when we need to get some extra memory back
   *
   * at some point, we might want to make this flush all the bundles,
   * because any bundles that are floating around when the locale changes
   * will suddenly contain bad data
   *
   */
  void flushBundles();

  [notxpcom, nostdcall] size_t sizeOfIncludingThis(in MallocSizeOf aMallocSizeOf);

  [notxpcom, nostdcall] void sendContentBundles(in ContentParent aContentParent);

  [notxpcom, nostdcall] void registerContentBundle(in ACString aBundleURL,
                                                   in ReadOnlySharedMemoryHandle aMapHandle);
};