DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (1a169f1e113d)

VCS Links

Line Code
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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/* -*- 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/. */

#include "nsISupports.idl"
#include "nsISupportsPrimitives.idl"

interface nsISimpleEnumerator;

%{C++
#include "nsString.h"
%}

/*
 * nsICategoryManager
 */

[scriptable, builtinclass, uuid(de021d54-57a3-4025-ae63-4c8eedbe74c0)]
interface nsICategoryEntry : nsISupportsCString
{
  readonly attribute ACString entry;

  readonly attribute ACString value;
};

[builtinclass, scriptable, uuid(3275b2cd-af6d-429a-80d7-f0c5120342ac)]
interface nsICategoryManager : nsISupports
{
    /**
     * Get the value for the given category's entry.
     * @param aCategory The name of the category ("protocol")
     * @param aEntry The entry you're looking for ("http")
     * @return The value.
     */
    ACString getCategoryEntry(in ACString aCategory, in ACString aEntry);

    /**
     * Add an entry to a category.
     * @param aCategory The name of the category ("protocol")
     * @param aEntry The entry to be added ("http")
     * @param aValue The value for the entry ("moz.httprulez.1")
     * @param aPersist Should this data persist between invocations?
     * @param aReplace Should we replace an existing entry?
     * @return Previous entry, if any
     */
    ACString addCategoryEntry(in ACString aCategory, in ACString aEntry,
                              in ACString aValue, in boolean aPersist,
                              in boolean aReplace);

    /**
     * Delete an entry from the category.
     * @param aCategory The name of the category ("protocol")
     * @param aEntry The entry to be added ("http")
     * @param aPersist Delete persistent data from registry, if present?
     */
    void deleteCategoryEntry(in ACString aCategory, in ACString aEntry,
                             in boolean aPersist);

    /**
     * Delete a category and all entries.
     * @param aCategory The category to be deleted.
     */
    void deleteCategory(in ACString aCategory);

    /**
     * Enumerate the entries in a category.
     * @param aCategory The category to be enumerated.
     * @return a simple enumerator, each result QIs to
     *         nsICategoryEntry.
     */
    nsISimpleEnumerator enumerateCategory(in ACString aCategory);


    /**
     * Enumerate all existing categories
     * @param aCategory The category to be enumerated.
     * @return a simple enumerator, each result QIs to
     *         nsISupportsCString.
     */
    nsISimpleEnumerator enumerateCategories();

    %{C++
    template<size_t N>
    nsresult
    GetCategoryEntry(const char (&aCategory)[N], const nsACString& aEntry,
                     nsACString& aResult)
    {
        return GetCategoryEntry(nsLiteralCString(aCategory),
                                aEntry, aResult);
    }

    template<size_t N, size_t M>
    nsresult
    GetCategoryEntry(const char (&aCategory)[N], const char (&aEntry)[M],
                     nsACString& aResult)
    {
        return GetCategoryEntry(nsLiteralCString(aCategory),
                                nsLiteralCString(aEntry),
                                aResult);
    }

    nsresult
    AddCategoryEntry(const nsACString& aCategory, const nsACString& aEntry,
                     const nsACString& aValue, bool aPersist, bool aReplace)
    {
        nsCString oldValue;
        return AddCategoryEntry(aCategory, aEntry, aValue, aPersist, aReplace,
                                oldValue);
    }

    template<size_t N>
    nsresult
    AddCategoryEntry(const char (&aCategory)[N], const nsACString& aEntry,
                     const nsACString& aValue, bool aPersist, bool aReplace)
    {
        nsCString oldValue;
        return AddCategoryEntry(nsLiteralCString(aCategory), aEntry, aValue,
                                aPersist, aReplace, oldValue);
    }

    template<size_t N>
    nsresult
    DeleteCategoryEntry(const char (&aCategory)[N], const nsACString& aEntry, bool aPersist)
    {
        return DeleteCategoryEntry(nsLiteralCString(aCategory), aEntry, aPersist);
    }


    template<size_t N>
    nsresult
    EnumerateCategory(const char (&aCategory)[N], nsISimpleEnumerator** aResult)
    {
        return EnumerateCategory(nsLiteralCString(aCategory), aResult);
    }
    %}
};