/* ide-formatter.h
 *
 * Copyright 2017-2019 Christian Hergert <chergert@redhat.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

#pragma once

#if !defined (IDE_CODE_INSIDE) && !defined (IDE_CODE_COMPILATION)
# error "Only <libide-code.h> can be included directly."
#endif

#include <gtk/gtk.h>
#include <libide-core.h>

#include "ide-code-types.h"

G_BEGIN_DECLS

#define IDE_TYPE_FORMATTER (ide_formatter_get_type())

IDE_AVAILABLE_IN_3_32
G_DECLARE_INTERFACE (IdeFormatter, ide_formatter, IDE, FORMATTER, IdeObject)

struct _IdeFormatterInterface
{
  GTypeInterface parent;

  void     (*load)                (IdeFormatter         *self);
  void     (*format_async)        (IdeFormatter         *self,
                                   IdeBuffer            *buffer,
                                   IdeFormatterOptions  *options,
                                   GCancellable         *cancellable,
                                   GAsyncReadyCallback   callback,
                                   gpointer              user_data);
  gboolean (*format_finish)       (IdeFormatter         *self,
                                   GAsyncResult         *result,
                                   GError              **error);
  void     (*format_range_async)  (IdeFormatter         *self,
                                   IdeBuffer            *buffer,
                                   IdeFormatterOptions  *options,
                                   const GtkTextIter    *begin,
                                   const GtkTextIter    *end,
                                   GCancellable         *cancellable,
                                   GAsyncReadyCallback   callback,
                                   gpointer              user_data);
  gboolean (*format_range_finish) (IdeFormatter         *self,
                                   GAsyncResult         *result,
                                   GError              **error);
};

IDE_AVAILABLE_IN_3_32
void     ide_formatter_load                (IdeFormatter         *self);
IDE_AVAILABLE_IN_3_32
void     ide_formatter_format_async        (IdeFormatter         *self,
                                            IdeBuffer            *buffer,
                                            IdeFormatterOptions  *options,
                                            GCancellable         *cancellable,
                                            GAsyncReadyCallback   callback,
                                            gpointer              user_data);
IDE_AVAILABLE_IN_3_32
gboolean ide_formatter_format_finish       (IdeFormatter         *self,
                                            GAsyncResult         *result,
                                            GError              **error);
IDE_AVAILABLE_IN_3_32
void     ide_formatter_format_range_async  (IdeFormatter         *self,
                                            IdeBuffer            *buffer,
                                            IdeFormatterOptions  *options,
                                            const GtkTextIter    *begin,
                                            const GtkTextIter    *end,
                                            GCancellable         *cancellable,
                                            GAsyncReadyCallback   callback,
                                            gpointer              user_data);
IDE_AVAILABLE_IN_3_32
gboolean ide_formatter_format_range_finish (IdeFormatter         *self,
                                            GAsyncResult         *result,
                                            GError              **error);

G_END_DECLS