gecko-dev/image/ImageWrapper.h
Nika Layzell 7ced96212e Bug 1778211 - Reject xpidl CDATA containing 'virtual', r=xpcom-reviewers,necko-reviewers,mccr8,dragana
We'll probably want to do something more accurate in the future with a
custom clang static analysis pass which validates that XPIDL interfaces
have the expected vtable and struct layout, however doing so would be
more involved than the string matching done in this patch.

In addition to checking for extra virtual methods, we'll likely also
want to check for data members on interfaces, and reject them unless the
class is marked as `[builtinclass]` in addition to some other attribute
which we'll need to add to prevent them from being implemented in Rust
(as c++ data members will not be reflected by the rust macro).

There were 2 instances of a comment which contained the word 'virtual'
within a CDATA block. These comments were moved out of the CDATA block
to avoid triggering the error.

Differential Revision: https://phabricator.services.mozilla.com/D151068
2022-07-06 14:53:06 +00:00

79 lines
2.4 KiB
C++

/* -*- Mode: C++; 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/. */
#ifndef mozilla_image_ImageWrapper_h
#define mozilla_image_ImageWrapper_h
#include "mozilla/MemoryReporting.h"
#include "Image.h"
namespace mozilla {
namespace image {
/**
* Abstract superclass for Images that wrap other Images.
*/
class ImageWrapper : public Image {
public:
NS_DECL_ISUPPORTS
NS_DECL_IMGICONTAINER
// Inherited methods from Image.
virtual already_AddRefed<ProgressTracker> GetProgressTracker() override;
virtual size_t SizeOfSourceWithComputedFallback(
SizeOfState& aState) const override;
virtual void CollectSizeOfSurfaces(nsTArray<SurfaceMemoryCounter>& aCounters,
MallocSizeOf aMallocSizeOf) const override;
virtual void IncrementAnimationConsumers() override;
virtual void DecrementAnimationConsumers() override;
#ifdef DEBUG
virtual uint32_t GetAnimationConsumers() override;
#endif
virtual nsresult OnImageDataAvailable(nsIRequest* aRequest,
nsIInputStream* aInStr,
uint64_t aSourceOffset,
uint32_t aCount) override;
virtual nsresult OnImageDataComplete(nsIRequest* aRequest, nsresult aStatus,
bool aLastPart) override;
virtual void OnSurfaceDiscarded(const SurfaceKey& aSurfaceKey) override;
virtual void SetInnerWindowID(uint64_t aInnerWindowId) override;
virtual uint64_t InnerWindowID() const override;
virtual bool HasError() override;
virtual void SetHasError() override;
nsIURI* GetURI() const override;
protected:
explicit ImageWrapper(Image* aInnerImage) : mInnerImage(aInnerImage) {
MOZ_ASSERT(aInnerImage, "Need an image to wrap");
}
virtual ~ImageWrapper() {}
/**
* Returns a weak reference to the inner image wrapped by this ImageWrapper.
*/
Image* InnerImage() const { return mInnerImage.get(); }
void SetInnerImage(Image* aInnerImage) {
MOZ_ASSERT(aInnerImage, "Need an image to wrap");
mInnerImage = aInnerImage;
}
private:
RefPtr<Image> mInnerImage;
};
} // namespace image
} // namespace mozilla
#endif // mozilla_image_ImageWrapper_h