/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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 globalmenu-extension.
 *
 * The Initial Developer of the Original Code is
 * Canonical Ltd.
 * Portions created by the Initial Developer are Copyright (C) 2010
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * Chris Coulson <chris.coulson@canonical.com>
 *
 * 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 ***** */

#include <nsIAtom.h>
#include <nsDebug.h>
#include <nsIContent.h>

#include <glib-object.h>
#include <libdbusmenu-glib/server.h>

#include "uGlobalMenuSeparator.h"
#include "uGlobalMenuBar.h"
#include "uGlobalMenu.h"
#include "uWidgetAtoms.h"

#include "uDebug.h"

void
uGlobalMenuSeparator::InitializeDbusMenuItem()
{
  if (!mDbusMenuItem) {
    mDbusMenuItem = dbusmenu_menuitem_new();
    if (!mDbusMenuItem) {
      return;
    }
  } else {
    OnlyKeepProperties(static_cast<uMenuObjectProperties>(eVisible | eType));
  }

  dbusmenu_menuitem_property_set(mDbusMenuItem,
                                 DBUSMENU_MENUITEM_PROP_TYPE,
                                 "separator");

  UpdateInfoFromContentClass();
  SyncVisibilityFromContent();
}

nsresult
uGlobalMenuSeparator::Init(uGlobalMenuObject *aParent,
                           uGlobalMenuDocListener *aListener,
                           nsIContent *aContent,
                           uGlobalMenuBar *aMenuBar)
{
  NS_ENSURE_ARG(aParent);
  NS_ENSURE_ARG(aListener);
  NS_ENSURE_ARG(aContent);
  NS_ENSURE_ARG(aMenuBar);

  mParent = aParent;
  mListener = aListener;
  mContent = aContent;
  mMenuBar = aMenuBar;

  nsresult rv = mListener->RegisterForContentChanges(mContent, this);
  if (NS_FAILED(rv)) {
    NS_WARNING("Failed to register for content changes");
    return rv;
  }

  return NS_OK;
}

uGlobalMenuSeparator::uGlobalMenuSeparator(): uGlobalMenuObject(eMenuSeparator)
{
  MOZ_COUNT_CTOR(uGlobalMenuSeparator);
}

uGlobalMenuSeparator::~uGlobalMenuSeparator()
{
  if (mListener) {
    mListener->UnregisterForContentChanges(mContent, this);
  }

  if (mDbusMenuItem)
    g_object_unref(mDbusMenuItem);

  MOZ_COUNT_DTOR(uGlobalMenuSeparator);
}

/*static*/ uGlobalMenuObject*
uGlobalMenuSeparator::Create(uGlobalMenuObject *aParent,
                             uGlobalMenuDocListener *aListener,
                             nsIContent *aContent,
                             uGlobalMenuBar *aMenuBar)
{
  TRACE_WITH_CONTENT(aContent);

  uGlobalMenuSeparator *menuitem = new uGlobalMenuSeparator();
  if (!menuitem) {
    return nsnull;
  }

  if (NS_FAILED(menuitem->Init(aParent, aListener, aContent, aMenuBar))) {
    delete menuitem;
    return nsnull;
  }

  return static_cast<uGlobalMenuObject *>(menuitem);
}

void
uGlobalMenuSeparator::AboutToShowNotify()
{
  if (IsDirty()) {
    UpdateInfoFromContentClass();
    SyncVisibilityFromContent();

    ClearInvalid();
  } else {
    UpdateVisibility();
  }
}

void
uGlobalMenuSeparator::ObserveAttributeChanged(nsIDocument *aDocument,
                                              nsIContent *aContent,
                                              nsIAtom *aAttribute)
{
  NS_ASSERTION(aContent == mContent, "Received an event that wasn't meant for us!");

  if (IsDirty()) {
    return;
  }

  if (mParent->GetType() == eMenu &&
      !(static_cast<uGlobalMenu *>(mParent))->IsOpenOrOpening()) {
    Invalidate();
    return;
  }

  if (aAttribute == uWidgetAtoms::hidden ||
      aAttribute == uWidgetAtoms::collapsed) {
    SyncVisibilityFromContent();
  } else if (aAttribute == uWidgetAtoms::_class) {
    UpdateInfoFromContentClass();
    SyncVisibilityFromContent();
  }
}

void
uGlobalMenuSeparator::ObserveContentRemoved(nsIDocument *aDocument,
                                            nsIContent *aContainer,
                                            nsIContent *aChild,
                                            PRInt32 aIndexInContainer)
{
  NS_ASSERTION(0, "We can't remove content from a menuseparator!");
}

void
uGlobalMenuSeparator::ObserveContentInserted(nsIDocument *aDocument,
                                             nsIContent *aContainer,
                                             nsIContent *aChild,
                                             PRInt32 aIndexInContainer)
{
  NS_ASSERTION(0, "We can't insert content in to a menuseparator!");
}