← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/extensions/webservices/soap/src/nsSOAPEncoding.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/extensions/webservices/soap/src/nsSOAPEncoding.h
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
9
 *
 
10
 * Software distributed under the License is distributed on an "AS IS" basis,
 
11
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
12
 * for the specific language governing rights and limitations under the
 
13
 * License.
 
14
 *
 
15
 * The Original Code is mozilla.org code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is 
 
18
 * Netscape Communications Corporation.
 
19
 * Portions created by the Initial Developer are Copyright (C) 2001
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *
 
24
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the NPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#ifndef nsSOAPEncoding_h__
 
40
#define nsSOAPEncoding_h__
 
41
 
 
42
#include "nsString.h"
 
43
#include "nsIDOMElement.h"
 
44
#include "nsISOAPEncoding.h"  // contains nsISOAPEncodingRegistry too
 
45
#include "nsISOAPEncoder.h"
 
46
#include "nsISOAPDecoder.h"
 
47
#include "nsCOMPtr.h"
 
48
#include "nsHashtable.h"
 
49
#include "nsISchema.h"
 
50
 
 
51
// Notes regarding the ownership model between the nsSOAPEncoding (encoding)
 
52
//   and the nsSOAPEncodingRegsitry (registry). To avoid cyclic referencing
 
53
//   and thereby leaking encodings and the registry holding them the registry 
 
54
//   was given ownership of the encodings. In the encoding specialized 
 
55
//   AddRef() and Release() functions were written to pass the refcounting
 
56
//   to the registry. Instead of ref couting the encodings all refs are
 
57
//   accumulated in the registry. When the registry is the only thing holding
 
58
//   on to the encodings it's own refcount will hit zero causing it to 
 
59
//   go away and take with it any encodings stored in its hashtable. To make
 
60
//   this work the registry had to be a weak reference (*-style pointer)
 
61
//   in each encoding and the storage of the encodings had to be weak as
 
62
//   well (*-style pointers in the nsObjectHashtable).
 
63
 
 
64
class nsSOAPEncodingRegistry : public nsISOAPEncodingRegistry
 
65
{
 
66
 
 
67
public:
 
68
  NS_DECL_ISUPPORTS 
 
69
  NS_DECL_NSISOAPENCODINGREGISTRY
 
70
 
 
71
  nsSOAPEncodingRegistry(nsISOAPEncoding *aEncoding);
 
72
 
 
73
  // the nsObjectHashtable has a callback to delete all the encodings
 
74
  //    the callback is defined in nsSOAPEncoding.cpp
 
75
  virtual ~nsSOAPEncodingRegistry() {}
 
76
 
 
77
protected:
 
78
  nsObjectHashtable mEncodings;
 
79
  nsCOMPtr < nsISchemaCollection > mSchemaCollection;
 
80
 
 
81
};
 
82
 
 
83
 
 
84
class nsSOAPEncoding : public nsISOAPEncoding
 
85
{
 
86
 
 
87
public:
 
88
  NS_DECL_ISUPPORTS
 
89
  NS_DECL_NSISOAPENCODING 
 
90
  
 
91
  nsSOAPEncoding();
 
92
  nsSOAPEncoding(const nsAString &aStyleURI,
 
93
                 nsSOAPEncodingRegistry *aRegistry,
 
94
                 nsISOAPEncoding *aDefaultEncoding);
 
95
  virtual ~nsSOAPEncoding() {}
 
96
 
 
97
protected:
 
98
  nsString mStyleURI;
 
99
  nsSupportsHashtable mEncoders;
 
100
  nsSupportsHashtable mDecoders;
 
101
 
 
102
  // Weak Reference to avoid cyclic refs and leaks. See notes above.
 
103
  nsISOAPEncodingRegistry *mRegistry;
 
104
 
 
105
  nsCOMPtr < nsISOAPEncoding > mDefaultEncoding;
 
106
  nsCOMPtr < nsISOAPEncoder > mDefaultEncoder;
 
107
  nsCOMPtr < nsISOAPDecoder > mDefaultDecoder;
 
108
  nsSupportsHashtable mMappedInternal;
 
109
  nsSupportsHashtable mMappedExternal;
 
110
 
 
111
};
 
112
#endif