dom/src/geolocation/nsGeoPositionIPCSerialiser.h
author Dão Gottwald <dao@mozilla.com>
Fri, 07 Jan 2011 21:27:00 +0100
changeset 60220 f03c81553b326dbe1516998584c3d31bf98e7a2f
parent 59870 c9bf08a67f28eb67f64d97d51827587c3fe26828
child 83084 1d0ffc477fe81f7203b13fa37eb1293098f441a8
permissions -rw-r--r--
Bug 614290 - Remove pinnedonly attribute when adding new tabs. r=gavin

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla geolocation code.
 *
 * The Initial Developer of the Original Code is Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2010
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Mike Kristoffersen <moz@mikek.dk> (Original Author)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef dom_src_geolocation_IPC_serialiser
#define dom_src_geolocation_IPC_serialiser


#include "IPC/IPCMessageUtils.h"
#include "nsGeoPosition.h"
#include "nsIDOMGeoPosition.h"

typedef nsIDOMGeoPositionAddress  *GeoPositionAddress;
typedef nsIDOMGeoPositionCoords   *GeoPositionCoords;
typedef nsIDOMGeoPosition         *GeoPosition;

namespace IPC {

template <>
struct ParamTraits<GeoPositionAddress>
{
  typedef GeoPositionAddress paramType;

  // Function to serialize a geo position address
  static void Write(Message *aMsg, const paramType& aParam)
  {
    bool isNull = !aParam;
    WriteParam(aMsg, isNull);
    // If it is null, then we are done
    if (isNull) return;

    nsString addressLine;

    aParam->GetStreetNumber(addressLine);
    WriteParam(aMsg, addressLine);

    aParam->GetStreet(addressLine);
    WriteParam(aMsg, addressLine);

    aParam->GetPremises(addressLine);
    WriteParam(aMsg, addressLine);

    aParam->GetCity(addressLine);
    WriteParam(aMsg, addressLine);

    aParam->GetCounty(addressLine);
    WriteParam(aMsg, addressLine);

    aParam->GetRegion(addressLine);
    WriteParam(aMsg, addressLine);

    aParam->GetCountry(addressLine);
    WriteParam(aMsg, addressLine);

    aParam->GetCountryCode(addressLine);
    WriteParam(aMsg, addressLine);

    aParam->GetPostalCode(addressLine);
    WriteParam(aMsg, addressLine);
  }

  // Function to de-serialize a geoposition
  static bool Read(const Message* aMsg, void **aIter, paramType* aResult)
  {
    // Check if it is the null pointer we have transfered
    bool isNull;
    if (!ReadParam(aMsg, aIter, &isNull)) return false;

    if (isNull) {
      *aResult = 0;
      return true;
    }

    // We need somewhere to store the address before we create the object
    nsString streetNumber;
    nsString street;
    nsString premises;
    nsString city;
    nsString county;
    nsString region;
    nsString country;
    nsString countryCode;
    nsString postalCode;

    // It's not important to us where it fails, but rather if it fails
    if (!(ReadParam(aMsg, aIter, &streetNumber) &&
          ReadParam(aMsg, aIter, &street      ) &&
          ReadParam(aMsg, aIter, &premises    ) &&
          ReadParam(aMsg, aIter, &city        ) &&
          ReadParam(aMsg, aIter, &county      ) &&
          ReadParam(aMsg, aIter, &region      ) &&
          ReadParam(aMsg, aIter, &country     ) &&
          ReadParam(aMsg, aIter, &countryCode ) &&
          ReadParam(aMsg, aIter, &postalCode  ))) return false;

    // We now have all the data
    *aResult = new nsGeoPositionAddress(streetNumber, /* aStreetNumber */
                                        street,       /* aStreet       */
                                        premises,     /* aPremises     */
                                        city,         /* aCity         */
                                        county,       /* aCounty       */
                                        region,       /* aRegion       */
                                        country,      /* aCountry      */
                                        countryCode,  /* aCountryCode  */
                                        postalCode    /* aPostalCode   */
                                       );
    return true;
  }
} ;

template <>
struct ParamTraits<GeoPositionCoords>
{
  typedef GeoPositionCoords paramType;

  // Function to serialize a geoposition
  static void Write(Message *aMsg, const paramType& aParam)
  {
    bool isNull = !aParam;
    WriteParam(aMsg, isNull);
    // If it is a null object, then we are done
    if (isNull) return;

    double coordData;

    aParam->GetLatitude(&coordData);
    WriteParam(aMsg, coordData);

    aParam->GetLongitude(&coordData);
    WriteParam(aMsg, coordData);

    aParam->GetAltitude(&coordData);
    WriteParam(aMsg, coordData);

    aParam->GetAccuracy(&coordData);
    WriteParam(aMsg, coordData);

    aParam->GetAltitudeAccuracy(&coordData);
    WriteParam(aMsg, coordData);

    aParam->GetHeading(&coordData);
    WriteParam(aMsg, coordData);

    aParam->GetSpeed(&coordData);
    WriteParam(aMsg, coordData);
  }

  // Function to de-serialize a geoposition
  static bool Read(const Message* aMsg, void **aIter, paramType* aResult)
  {
    // Check if it is the null pointer we have transfered
    bool isNull;
    if (!ReadParam(aMsg, aIter, &isNull)) return false;

    if (isNull) {
      *aResult = 0;
      return true;
    }

    double latitude;
    double longitude;
    double altitude;
    double accuracy;
    double altitudeAccuracy;
    double heading;
    double speed;

    // It's not important to us where it fails, but rather if it fails
    if (!(   ReadParam(aMsg, aIter, &latitude         )
          && ReadParam(aMsg, aIter, &longitude        )
          && ReadParam(aMsg, aIter, &altitude         )
          && ReadParam(aMsg, aIter, &accuracy         )
          && ReadParam(aMsg, aIter, &altitudeAccuracy )
          && ReadParam(aMsg, aIter, &heading          )
          && ReadParam(aMsg, aIter, &speed            ))) return false;

    // We now have all the data
    *aResult = new nsGeoPositionCoords(latitude,         /* aLat     */
                                       longitude,        /* aLong    */
                                       altitude,         /* aAlt     */
                                       accuracy,         /* aHError  */
                                       altitudeAccuracy, /* aVError  */
                                       heading,          /* aHeading */
                                       speed             /* aSpeed   */
                                      );
    return true;

  }

};

template <>
struct ParamTraits<GeoPosition>
{
  typedef GeoPosition paramType;

  // Function to serialize a geoposition
  static void Write(Message *aMsg, const paramType& aParam)
  {
    bool isNull = !aParam;
    WriteParam(aMsg, isNull);
    // If it is a null object, then we are done
    if (isNull) return;

    DOMTimeStamp timeStamp;
    aParam->GetTimestamp(&timeStamp);
    WriteParam(aMsg, timeStamp);

    nsCOMPtr<nsIDOMGeoPositionCoords> coords;
    aParam->GetCoords(getter_AddRefs(coords));
    GeoPositionCoords simpleCoords = coords.get();
    WriteParam(aMsg, simpleCoords);

    nsCOMPtr<nsIDOMGeoPositionAddress> address;
    aParam->GetAddress(getter_AddRefs(address));
    GeoPositionAddress simpleAddress = address.get();
    WriteParam(aMsg, simpleAddress);
  }

  // Function to de-serialize a geoposition
  static bool Read(const Message* aMsg, void **aIter, paramType* aResult)
  {
    // Check if it is the null pointer we have transfered
    bool isNull;
    if (!ReadParam(aMsg, aIter, &isNull)) return false;

    if (isNull) {
      *aResult = 0;
      return true;
    }

    DOMTimeStamp timeStamp;
    GeoPositionCoords coords = nsnull;
    GeoPositionAddress address;

    // It's not important to us where it fails, but rather if it fails
    if (!(   ReadParam(aMsg, aIter, &timeStamp)
          && ReadParam(aMsg, aIter, &coords   )
          && ReadParam(aMsg, aIter, &address  ))) {
          // note it is fine to do "delete nsnull" in case coords hasn't
          // been allocated and we will never have a case where address
          // gets allocated and we end here
          delete coords;
          return false;
      }

    *aResult = new nsGeoPosition(coords, address, timeStamp);

    return true;
  };

};

}

#endif