/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* 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 nsXBLContentSink_h__

#define nsXBLContentSink_h__

#include "mozilla/Attributes.h"

#include "nsXMLContentSink.h"

#include "nsXBLDocumentInfo.h"

#include "nsXBLPrototypeHandler.h"

#include "nsXBLProtoImpl.h"

#include "nsLayoutCID.h"

/*

 * Enum that describes the primary state of the parsing process

 */

typedef enum {

  eXBL_InDocument,       /* outside any bindings */

  eXBL_InBindings,       /* Inside a <bindings> element */

  eXBL_InBinding,        /* Inside a <binding> */

  eXBL_InResources,      /* Inside a <resources> */

  eXBL_InImplementation, /* Inside a <implementation> */

  eXBL_InHandlers,       /* Inside a <handlers> */

  eXBL_Error             /* An error has occurred.  Suspend binding construction */

} XBLPrimaryState;

/*

 * Enum that describes our substate (typically when parsing something

 * like <handlers> or <implementation>).

 */

typedef enum {

  eXBL_None,

  eXBL_InHandler,

  eXBL_InMethod,

  eXBL_InProperty,

  eXBL_InField,

  eXBL_InBody,

  eXBL_InGetter,

  eXBL_InSetter,

  eXBL_InConstructor,

  eXBL_InDestructor

} XBLSecondaryState;

class nsXULPrototypeElement;

class nsXBLProtoImplMember;

class nsXBLProtoImplProperty;

class nsXBLProtoImplMethod;

class nsXBLProtoImplField;

class nsXBLPrototypeBinding;

// The XBL content sink overrides the XML content sink to

// builds its own lightweight data structures for the <resources>,

// <handlers>, <implementation>, and

class nsXBLContentSink : public nsXMLContentSink {

public:

  nsXBLContentSink();

  ~nsXBLContentSink();

  nsresult Init(nsIDocument* aDoc,

                nsIURI* aURL,

                nsISupports* aContainer);

  // nsIContentSink overrides

  NS_IMETHOD HandleStartElement(const char16_t *aName,

                                const char16_t **aAtts,

                                uint32_t aAttsCount,

                                uint32_t aLineNumber,

                                uint32_t aColumnNumber) override;

  NS_IMETHOD HandleEndElement(const char16_t *aName) override;

  NS_IMETHOD HandleCDataSection(const char16_t *aData,

                                uint32_t aLength) override;

protected:

    // nsXMLContentSink overrides

    virtual void MaybeStartLayout(bool aIgnorePendingSheets) override;

    bool OnOpenContainer(const char16_t **aAtts,

                           uint32_t aAttsCount,

                           int32_t aNameSpaceID,

                           nsAtom* aTagName,

                           uint32_t aLineNumber) override;

    bool NotifyForDocElement() override { return false; }

    nsresult CreateElement(const char16_t** aAtts, uint32_t aAttsCount,

                           mozilla::dom::NodeInfo* aNodeInfo,

                           uint32_t aLineNumber, uint32_t aColumnNumber,

                           nsIContent** aResult, bool* aAppendContent,

                           mozilla::dom::FromParser aFromParser) override;

    nsresult AddAttributes(const char16_t** aAtts, Element* aElement) override;

#ifdef MOZ_XUL

    nsresult AddAttributesToXULPrototype(const char16_t **aAtts,

                                         uint32_t aAttsCount,

                                         nsXULPrototypeElement* aElement);

#endif

    // Our own helpers for constructing XBL prototype objects.

    nsresult ConstructBinding(uint32_t aLineNumber);

    void ConstructHandler(const char16_t **aAtts, uint32_t aLineNumber);

    void ConstructResource(const char16_t **aAtts, nsAtom* aResourceType);

    void ConstructImplementation(const char16_t **aAtts);

    void ConstructProperty(const char16_t **aAtts, uint32_t aLineNumber);

    void ConstructMethod(const char16_t **aAtts);

    void ConstructParameter(const char16_t **aAtts);

    void ConstructField(const char16_t **aAtts, uint32_t aLineNumber);

  // nsXMLContentSink overrides

  nsresult FlushText(bool aReleaseTextNode = true) override;

  // nsIExpatSink overrides

  NS_IMETHOD ReportError(const char16_t* aErrorText,

                         const char16_t* aSourceText,

                         nsIScriptError *aError,

                         bool *_retval) override;

protected:

  nsresult ReportUnexpectedElement(nsAtom* aElementName, uint32_t aLineNumber);

  void AddMember(nsXBLProtoImplMember* aMember);

  void AddField(nsXBLProtoImplField* aField);

  XBLPrimaryState mState;

  XBLSecondaryState mSecondaryState;

  nsXBLDocumentInfo* mDocInfo;

  bool mIsChromeOrResource; // For bug #45989

  bool mFoundFirstBinding;

  nsString mCurrentBindingID;

  nsXBLPrototypeBinding* mBinding;

  nsXBLPrototypeHandler* mHandler; // current handler, owned by its PrototypeBinding

  nsXBLProtoImpl* mImplementation;

  nsXBLProtoImplMember* mImplMember;

  nsXBLProtoImplField* mImplField;

  nsXBLProtoImplProperty* mProperty;

  nsXBLProtoImplMethod* mMethod;

  nsXBLProtoImplField* mField;

};

nsresult

NS_NewXBLContentSink(nsIXMLContentSink** aResult,

                     nsIDocument* aDoc,

                     nsIURI* aURL,

                     nsISupports* aContainer);

#endif // nsXBLContentSink_h__