dom/base/BodyUtil.h
author James Cheng <jacheng@mozilla.com>
Fri, 05 Aug 2016 13:23:44 -0400
changeset 308428 8ee6f2eb8b349a351f6f76585eb85e0ec2b5c475
parent 285954 faaf448b9788574b99b0fd0dc554879899edcdf4
child 388518 cb123c84818a3c491fb9d63f00891d23f515cf6f
permissions -rw-r--r--
Bug 1291229 - Fix typo for moving Java bindings to mozilla::java namespace. r=jchen MozReview-Commit-ID: KGAS6EhnwAI

/* 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_dom_BodyUtil_h
#define mozilla_dom_BodyUtil_h

#include "nsString.h"
#include "nsError.h"

#include "mozilla/ErrorResult.h"
#include "mozilla/dom/File.h"
#include "mozilla/dom/FormData.h"

namespace mozilla {
namespace dom {

class BodyUtil final
{
private:
  BodyUtil() = delete;

public:
  /**
   * Creates an array buffer from an array, assigning the result to |aValue|.
   * The array buffer takes ownership of |aInput|, which must be allocated
   * by |malloc|.
   */
  static void
  ConsumeArrayBuffer(JSContext* aCx, JS::MutableHandle<JSObject*> aValue,
                     uint32_t aInputLength, uint8_t* aInput, ErrorResult& aRv);

  /**
   * Creates an in-memory blob from an array. The blob takes ownership of
   * |aInput|, which must be allocated by |malloc|.
   */
  static already_AddRefed<Blob>
  ConsumeBlob(nsISupports* aParent, const nsString& aMimeType,
              uint32_t aInputLength, uint8_t* aInput, ErrorResult& aRv);

  /**
   * Creates a form data object from a UTF-8 encoded |aStr|. Returns |nullptr|
   * and sets |aRv| to MSG_BAD_FORMDATA if |aStr| contains invalid data.
   */
  static already_AddRefed<FormData>
  ConsumeFormData(nsIGlobalObject* aParent, const nsCString& aMimeType,
                  const nsCString& aStr, ErrorResult& aRv);

  /**
   * UTF-8 decodes |aInput| into |aText|. The caller may free |aInput|
   * once this method returns.
   */
  static nsresult
  ConsumeText(uint32_t aInputLength, uint8_t* aInput, nsString& aText);

  /**
   * Parses a UTF-8 encoded |aStr| as JSON, assigning the result to |aValue|.
   * Sets |aRv| to a syntax error if |aStr| contains invalid data.
   */
  static void
  ConsumeJson(JSContext* aCx, JS::MutableHandle<JS::Value> aValue,
              const nsString& aStr, ErrorResult& aRv);
};

} // namespace dom
} // namespace mozilla

#endif // mozilla_dom_BodyUtil_h