AISTargetQueryDialog.cpp

/******************************************************************************
 *
 * Project:  OpenCPN
 *
 ***************************************************************************
 *   Copyright (C) 2013 by David S. Register                               *
 *                                                                         *
 *   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 2 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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 ***************************************************************************
 */
 
#include <wx/wxprec.h>
 
#include <wx/html/htmlwin.h>
 
#include "AISTargetQueryDialog.h"
#include "chcanv.h"
#include "navutil.h"
#include "ais.h"
#include "FontMgr.h"
#include "ais_target_data.h"
#include "ais_decoder.h"
#include "select.h"
#include "routemanagerdialog.h"
#include "OCPNPlatform.h"
#include "track.h"
#include "route_point.h"
#include "ocpn_frame.h"
 
extern AISTargetQueryDialog *g_pais_query_dialog_active;
extern int g_ais_query_dialog_x;
extern int g_ais_query_dialog_y;
extern ColorScheme global_color_scheme;
extern AisDecoder *g_pAIS;
extern wxString g_default_wp_icon;
extern Select *pSelect;
extern MyConfig *pConfig;
extern RouteManagerDialog *pRouteManagerDialog;
extern std::vector<Track*> g_TrackList;
extern OCPNPlatform *g_Platform;
extern MyFrame *gFrame;
 
#define xID_OK 10009
#define xID_WPT_CREATE 10010
#define xID_TRK_CREATE 10011
IMPLEMENT_CLASS(AISTargetQueryDialog, wxDialog)
// AISTargetQueryDialog event table definition
BEGIN_EVENT_TABLE(AISTargetQueryDialog, wxFrame)
EVT_BUTTON(xID_OK, AISTargetQueryDialog::OnIdOKClick)
EVT_BUTTON(xID_WPT_CREATE, AISTargetQueryDialog::OnIdWptCreateClick)
EVT_BUTTON(xID_TRK_CREATE, AISTargetQueryDialog::OnIdTrkCreateClick)
EVT_CLOSE(AISTargetQueryDialog::OnClose)
EVT_MOVE(AISTargetQueryDialog::OnMove)
EVT_SIZE(AISTargetQueryDialog::OnSize)
EVT_CHAR_HOOK(AISTargetQueryDialog::OnKey)
END_EVENT_TABLE()
 
AISTargetQueryDialog::AISTargetQueryDialog() { Init(); }
 
AISTargetQueryDialog::AISTargetQueryDialog(wxWindow *parent, wxWindowID id,
                                           const wxString &caption,
                                           const wxPoint &pos,
                                           const wxSize &size, long style) {
  Init();
  Create(parent, id, caption, pos, size, style);
}
 
AISTargetQueryDialog::~AISTargetQueryDialog() { delete m_pQueryTextCtl; }
 
void AISTargetQueryDialog::Init() {
  m_MMSI = -1;
  m_pQueryTextCtl = NULL;
  m_nl = 0;
  m_colorscheme = (ColorScheme)(-1);
  m_okButton = NULL;
  m_bsize_set = false;
  m_bautoCentre = false;
  m_bautosize = false;
}
void AISTargetQueryDialog::OnClose(wxCloseEvent &event) {
  Destroy();
  g_pais_query_dialog_active = NULL;
}
 
void AISTargetQueryDialog::OnIdOKClick(wxCommandEvent &event) { Close(); }
 
void AISTargetQueryDialog::OnKey(wxKeyEvent &ke) {
  if (ke.GetKeyCode() == WXK_ESCAPE)
    Close(true);
  else
    ke.Skip();
}
 
void AISTargetQueryDialog::OnIdWptCreateClick(wxCommandEvent &event) {
  if (m_MMSI != 0) {  //  Faulty MMSI could be reported as 0
    auto td = g_pAIS->Get_Target_Data_From_MMSI(m_MMSI);
    if (td) {
      wxString n0 = wxString::Format(wxT("%s"), td->ShipName);
      n0.Replace(_T("@"), _T(" "));
      n0.Trim();
      wxString mmsi = wxString::Format(wxT("%i "), td->MMSI);
      wxString n = _T("\"") + n0 + _T("\" ") + mmsi;
      n.append(wxDateTime::Now().Format(wxT("%H:%M")));
      // wxString n =  wxString::Format(wxT("\"%s\"  %i "),td->ShipName,
      // td->MMSI).append(wxDateTime::Now().Format(wxT("%H:%M")));
      RoutePoint *pWP =
          new RoutePoint(td->Lat, td->Lon, g_default_wp_icon, n, wxEmptyString);
      pWP->m_bIsolatedMark = true;  // This is an isolated mark
      pSelect->AddSelectableRoutePoint(td->Lat, td->Lon, pWP);
      pConfig->AddNewWayPoint(pWP, -1);  // use auto next num
 
      if (pRouteManagerDialog && pRouteManagerDialog->IsShown())
        pRouteManagerDialog->UpdateWptListCtrl();
      gFrame->GetPrimaryCanvas()->undo->BeforeUndoableAction(
          Undo_CreateWaypoint, pWP, Undo_HasParent, NULL);
      gFrame->GetPrimaryCanvas()->undo->AfterUndoableAction(NULL);
      Refresh(false);
    }
  }
}
 
void AISTargetQueryDialog::OnIdTrkCreateClick(wxCommandEvent &event) {
  if (m_MMSI != 0) {  //  Faulty MMSI could be reported as 0
    auto td = g_pAIS->Get_Target_Data_From_MMSI(m_MMSI);
    if (td) {
      if (td->b_PersistTrack)  // The target was tracked and the user wants to
                               // stop it
      {
        td->b_PersistTrack = false;
        g_pAIS->m_persistent_tracks.erase(td->MMSI);
        m_createTrkBtn->SetLabel(_("Record Track"));
      } else {
        TrackPoint *tp = NULL;
        TrackPoint *tp1 = NULL;
 
        Track *t = new Track();
 
        t->SetName(wxString::Format(_T("AIS %s (%u) %s %s"),
                                    td->GetFullName().c_str(), td->MMSI,
                                    wxDateTime::Now().FormatISODate().c_str(),
                                    wxDateTime::Now().FormatISOTime().c_str()));
        for (const AISTargetTrackPoint &ptrack_point : td->m_ptrack) {
          vector2D point(ptrack_point.m_lon, ptrack_point.m_lat);
          tp1 = t->AddNewPoint(point, wxDateTime(ptrack_point.m_time).ToUTC());
          if (tp) {
            pSelect->AddSelectableTrackSegment(tp->m_lat, tp->m_lon, tp1->m_lat,
                                               tp1->m_lon, tp, tp1, t);
          }
          tp = tp1;
        }
 
        g_TrackList.push_back(t);
        pConfig->AddNewTrack(t);
        //                t->RebuildGUIDList(); // ensure the GUID list is
        //                intact and good
 
        if (pRouteManagerDialog && pRouteManagerDialog->IsShown())
          pRouteManagerDialog->UpdateTrkListCtrl();
        Refresh(false);
 
        if (wxID_YES ==
            OCPNMessageBox(
                NULL,
                _("The recently captured track of this target has been "
                  "recorded.\nDo you want to continue recording until the end "
                  "of the current OpenCPN session?"),
                _("OpenCPN Info"), wxYES_NO | wxCENTER, 60)) {
          td->b_PersistTrack = true;
          g_pAIS->m_persistent_tracks[td->MMSI] = t;
        }
      }
    }
  }
}
 
bool AISTargetQueryDialog::Create(wxWindow *parent, wxWindowID id,
                                  const wxString &caption, const wxPoint &pos,
                                  const wxSize &size, long style) {
  //    As a display optimization....
  //    if current color scheme is other than DAY,
  //    Then create the dialog ..WITHOUT.. borders and title bar.
  //    This way, any window decorations set by external themes, etc
  //    will not detract from night-vision
 
  long wstyle = AIS_TARGET_QUERY_STYLE;
  if ((global_color_scheme != GLOBAL_COLOR_SCHEME_DAY) &&
      (global_color_scheme != GLOBAL_COLOR_SCHEME_RGB))
    wstyle |= (wxNO_BORDER);
 
  if (!wxFrame::Create(parent, id, caption, pos, size, wstyle)) return false;
 
  m_parent = parent;
 
  wxFont *dFont = FontMgr::Get().GetFont(_("AISTargetQuery"));
  int font_size = wxMax(8, dFont->GetPointSize());
  wxString face = dFont->GetFaceName();
#ifdef __WXGTK__
  face = _T("Monospace");
#endif
  m_basefont = FontMgr::Get().FindOrCreateFont(font_size, wxFONTFAMILY_MODERN,
                                               wxFONTSTYLE_NORMAL,
                                               dFont->GetWeight(), false, face);
 
  SetFont(*m_basefont);
  m_adjustedFontSize = dFont->GetPointSize();
  m_control_font_size = dFont->GetPointSize();
 
  CreateControls();
 
  SetColorScheme(global_color_scheme);
 
  // Set the maximum size of the entire settings dialog
  wxSize sz = g_Platform->getDisplaySize();
  SetSizeHints(50, 50, sz.x - 20, sz.y - 40);
 
  if (!m_bautosize) {
    Fit();  // Sets the horizontal size OK
    Layout();
    SetSize(-1, m_adjustedFontSize * 30);  // Estimated vertical size
  }
 
  return true;
}
 
void AISTargetQueryDialog::SetMMSI(int mmsi) {
  m_MMSI = mmsi;
 
  auto td = g_pAIS->Get_Target_Data_From_MMSI(m_MMSI);
  AdjustBestSize(td.get());
}
 
void AISTargetQueryDialog::RecalculateSize() {
  auto td = g_pAIS->Get_Target_Data_From_MMSI(m_MMSI);
  AdjustBestSize(td.get());
  return;
}
 
void AISTargetQueryDialog::SetColorScheme(ColorScheme cs) {
  DimeControl(this);
  wxColor bg = GetBackgroundColour();
  m_pQueryTextCtl->SetBackgroundColour(bg);
  SetBackgroundColour(
      bg);  // This looks like non-sense, but is needed for __WXGTK__
            // to get colours to propagate down the control's family tree.
 
#ifdef __WXQT__
  //  wxQT has some trouble clearing the background of HTML window...
  wxBitmap tbm(GetSize().x, GetSize().y, -1);
  wxMemoryDC tdc(tbm);
  //    wxColour cback = GetGlobalColor( _T("YELO1") );
  tdc.SetBackground(bg);
  tdc.Clear();
  m_pQueryTextCtl->SetBackgroundImage(tbm);
#endif
 
  if (cs != m_colorscheme) {
    Refresh();
  }
  m_colorscheme = cs;
}
 
void AISTargetQueryDialog::CreateControls() {
  wxBoxSizer *topSizer = new wxBoxSizer(wxVERTICAL);
  SetSizer(topSizer);
 
  m_pQueryTextCtl =
      new wxHtmlWindow(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
                       wxHW_SCROLLBAR_AUTO | wxHW_NO_SELECTION);
  m_pQueryTextCtl->SetBorders(1);
  topSizer->Add(m_pQueryTextCtl, 1, wxEXPAND, 5);
 
  wxSizer *opt = new wxBoxSizer(wxHORIZONTAL);
  m_createWptBtn = new wxButton(this, xID_WPT_CREATE, _("Create Waypoint"),
                                wxDefaultPosition, wxDefaultSize, 0);
  opt->Add(m_createWptBtn, 0, wxALL | wxEXPAND, 5);
 
  m_createTrkBtn = new wxButton(this, xID_TRK_CREATE, _("Record Track"),
                                wxDefaultPosition, wxDefaultSize, 0);
  opt->Add(m_createTrkBtn, 0, wxALL | wxEXPAND, 5);
  topSizer->Add(opt, 0, wxALIGN_CENTER_HORIZONTAL | wxBOTTOM, 5);
 
  topSizer->Add(new wxButton(this, xID_OK, _("OK")), 0,
                wxALIGN_CENTER_HORIZONTAL | wxBOTTOM, 5);
 
  Fit();
}
 
void AISTargetQueryDialog::UpdateText() {
  wxString html;
 
  if (!m_pQueryTextCtl) return;
 
  int scroll_x, scroll_y;
  m_pQueryTextCtl->GetViewStart(&scroll_x, &scroll_y);
 
  auto td = g_pAIS->Get_Target_Data_From_MMSI(m_MMSI);
  //    AdjustBestSize(td);
 
  DimeControl(this);
  wxColor bg = GetBackgroundColour();
  m_pQueryTextCtl->SetBackgroundColour(bg);
  SetBackgroundColour(bg);
 
  if (td) {
    if (td->b_PersistTrack)
      m_createTrkBtn->SetLabel(_("Stop Tracking"));
    else
      m_createTrkBtn->SetLabel(_("Record Track"));
 
    m_createWptBtn->Enable(td->b_positionOnceValid);
    m_createTrkBtn->Enable(td->b_show_track);
 
    RenderHTMLQuery(td.get());
  }
 
#ifdef __WXQT__
  SetColorScheme(m_colorscheme);
#endif
 
  m_pQueryTextCtl->Scroll(scroll_x, scroll_y);
}
 
void AISTargetQueryDialog::OnMove(wxMoveEvent &event) {
  //    Record the dialog position
  wxPoint p = event.GetPosition();
  g_ais_query_dialog_x = p.x;
  g_ais_query_dialog_y = p.y;
 
  event.Skip();
}
 
void AISTargetQueryDialog::OnSize(wxSizeEvent &event) { event.Skip(); }
 
void AISTargetQueryDialog::AdjustBestSize(AisTargetData *td) {
  if (!td) return;
 
  wxSize origSize = GetSize();
 
  //  First pass, try to set the size using the user specified font sizes
  //  completely
  if (!m_bsize_set) {
    Fit();
    RenderHTMLQuery(td);
    m_bsize_set = true;
  }
 
  int target_x = -1;
  int target_y = -1;
 
  //  Width adjustments
 
  if (m_bautosize) {
    //  Reduce the font size if necessary to eliminate horizontal scroll bars.
    wxSize szv = m_pQueryTextCtl->GetVirtualSize();
    if (szv.x > m_pQueryTextCtl->GetSize().x) {
      while ((szv.x > m_pQueryTextCtl->GetSize().x) &&
             (m_adjustedFontSize > 8)) {  // fluff
        m_adjustedFontSize--;
 
        RenderHTMLQuery(td);
        m_pQueryTextCtl->Refresh();
        m_pQueryTextCtl->Update();
        Layout();
        szv = m_pQueryTextCtl->GetVirtualSize();
      }
 
      m_adjustedFontSize--;
    }
  } else {
    wxSize szv = m_pQueryTextCtl->GetVirtualSize();
    int csz = g_Platform->getDisplaySize().x * 8 / 10;
    if ((szv.x) < csz) {
      if (szv.x > m_pQueryTextCtl->GetSize().x) target_x = szv.x;  // * 11/10;
    }
  }
 
  // Now adjust the font size used for the control buttons.
  // This adjustment makes sure that the two horizontal buttons are not wider
  // than the platform display allows.
 
  if (m_createWptBtn && m_createTrkBtn) {
    wxSize psz = g_Platform->getDisplaySize();
 
    wxScreenDC dc;
    wxFont *tFont = FontMgr::Get().FindOrCreateFont(
        m_control_font_size, wxFONTFAMILY_MODERN, wxFONTSTYLE_NORMAL,
        m_basefont->GetWeight(), false, m_basefont->GetFaceName());
    dc.SetFont(*tFont);
 
    wxSize tsz = dc.GetTextExtent(m_createWptBtn->GetLabel() +
                                  m_createTrkBtn->GetLabel());
 
    float totalButtonWidth = tsz.x;
 
    if (totalButtonWidth * 1.5 > psz.x) {
      float delta = (float)totalButtonWidth * 2. / psz.x;
 
      float font_size = m_control_font_size / delta;
 
      wxFont *fp_font = FontMgr::Get().FindOrCreateFont(
          font_size, wxFONTFAMILY_MODERN, wxFONTSTYLE_NORMAL,
          m_basefont->GetWeight(), false, m_basefont->GetFaceName());
 
      m_createWptBtn->SetFont(*fp_font);
      m_createTrkBtn->SetFont(*fp_font);
 
      m_control_font_size = font_size;
    }
  }
 
  // Height adjustments
  // Try to avoid vertical scroll bar if possible.
 
  //  Estimate the control button area height
  int yb = 0;
  if (m_createWptBtn) yb = m_createWptBtn->GetSize().y * 4;
 
  wxSize szyv = m_pQueryTextCtl->GetVirtualSize();
  int csz = g_Platform->getDisplaySize().y * 85 / 100;
  if ((szyv.y + yb) < csz) {
    if (szyv.y > m_pQueryTextCtl->GetSize().y)
      target_y = (szyv.y * 11 / 10) + yb;
  } else {  // Probably going to be a vertical scroll bar, so adjust width
            // slightly
    target_y = csz;
    target_x = szyv.x * 11 / 10;
  }
 
  SetSize(target_x, target_y);
 
  wxSize nowSize = GetSize();
 
  if (nowSize != origSize) {
    if (m_bautoCentre) Centre();
  }
}
 
void AISTargetQueryDialog::RenderHTMLQuery(AisTargetData *td) {
  int font_size = m_adjustedFontSize;
  wxFont *fp_font = FontMgr::Get().FindOrCreateFont(
      font_size, wxFONTFAMILY_MODERN, wxFONTSTYLE_NORMAL,
      m_basefont->GetWeight(), false, m_basefont->GetFaceName());
 
  SetFont(*fp_font);
 
  int sizes[7];
  for (int i = -2; i < 5; i++) {
    sizes[i + 2] = fp_font->GetPointSize() + i + (i > 0 ? i : 0);
  }
 
  wxString html;
  wxColor bg = GetBackgroundColour();
  wxColor fg = GetForegroundColour();
 
  html.Printf(
      _T("<html><body bgcolor=#%02x%02x%02x><font ")
      _T("color=#%02x%02x%02x><center>"),
      bg.Red(), bg.Green(), bg.Blue(), fg.Red(), fg.Green(), fg.Blue());
 
  html << td->BuildQueryResult();
 
  html << _T("</center></font></body></html>");
 
  m_pQueryTextCtl->SetFonts(fp_font->GetFaceName(), fp_font->GetFaceName(),
                            sizes);
 
  wxCharBuffer buf = html.ToUTF8();
  if (buf.data())  // string OK?
    m_pQueryTextCtl->SetPage(html);
}