MVP

- BeginPopupContextItem
- BeginPopupContextWindow
- BeginPopupContextVoid

For #132

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "imgui"]
 	path = imgui
 	url = https://github.com/ocornut/imgui
+[submodule "implot"]
+	path = implot
+	url = https://github.com/epezent/implot.git

dear-imgui.cabal

@@ -22,7 +22,9 @@ extra-source-files:
   imgui/backends/*.h,
   imgui/backends/*.mm,
   imgui/imconfig.h,
-  imgui/LICENSE.txt
+  imgui/LICENSE.txt,
+  implot/*.h,
+  implot/LICENSE
 
 common exe-flags
   if flag(debug)
@@ -140,6 +142,7 @@ library
   exposed-modules:
     DearImGui
     DearImGui.FontAtlas
+    DearImGui.Plot
     DearImGui.Raw
     DearImGui.Raw.DrawList
     DearImGui.Raw.Font
@@ -147,6 +150,7 @@ library
     DearImGui.Raw.Font.GlyphRanges
     DearImGui.Raw.ListClipper
     DearImGui.Raw.IO
+    DearImGui.Raw.Plot
   other-modules:
     DearImGui.Context
     DearImGui.Enums
@@ -158,10 +162,14 @@ library
     imgui/imgui_draw.cpp
     imgui/imgui_tables.cpp
     imgui/imgui_widgets.cpp
+    implot/implot.cpp
+    implot/implot_demo.cpp
+    implot/implot_items.cpp
   extra-libraries:
     stdc++
   include-dirs:
     imgui
+    implot
   build-depends:
       dear-imgui-generator
     , containers

examples/glfw/Main.hs

@@ -64,9 +64,14 @@ mainLoop win = do
       text "Hello, ImGui!"
 
       -- Add a button widget, and call 'putStrLn' when it's clicked
-      button "Clickety Click" >>= \case
+      clicking <- button "Clickety Click"
-        False -> return ()
+      when clicking $
-        True  -> putStrLn "Ow!"
+        putStrLn "Ow!"
+      itemContextPopup do
+        text "pop!"
+        button "ok" >>= \clicked ->
+          when clicked $
+            closeCurrentPopup
 
     -- Show the ImGui demo window
     showDemoWindow

generator/DearImGui/Generator.hs

@@ -74,9 +74,15 @@ headers = $( do
   basicHeaders <- TH.runIO do
     headersPath  <- canonicalizePath ( takeDirectory currentPath <> "/../../imgui/imgui.h" )
     headersSource <- Text.readFile headersPath
-    tokens <- case tokenise headersSource of
+    tokensImGui <- case tokenise headersSource of
       Left  err  -> error ( "Couldn't tokenise Dear ImGui headers:\n\n" <> show err )
       Right toks -> pure toks
+    headersPath  <- canonicalizePath ( takeDirectory currentPath <> "/../../implot/implot.h" )
+    headersSource <- Text.readFile headersPath
+    tokensImPlot <- case tokenise headersSource of
+      Left  err  -> error ( "Couldn't tokenise Dear ImPlot headers:\n\n" <> show err )
+      Right toks -> pure toks
+    let tokens = tokensImGui<>tokensImPlot
     case Megaparsec.parse Parser.headers "" tokens of
       Left  err -> do
         let

src/DearImGui.hs

@@ -190,6 +190,9 @@ module DearImGui
 
     -- ** Selectables
   , selectable
+  , selectableWith
+  , SelectableOptions(..)
+  , defSelectableOptions
 
     -- ** List Boxes
   , listBox
@@ -234,19 +237,46 @@ module DearImGui
   , Raw.endTooltip
 
     -- * Popups/Modals
+
+    -- ** Generic
   , withPopup
   , withPopupOpen
   , beginPopup
+  , Raw.endPopup
 
+    -- ** Modal
   , withPopupModal
   , withPopupModalOpen
   , beginPopupModal
 
-  , Raw.endPopup
+    -- ** Item context
+  , itemContextPopup
+  , withPopupContextItemOpen
+  , withPopupContextItem
+  , beginPopupContextItem
 
+    -- ** Window context
+  , windowContextPopup
+  , withPopupContextWindowOpen
+  , withPopupContextWindow
+  , beginPopupContextWindow
+
+    -- ** Void context
+  , voidContextPopup
+  , withPopupContextVoidOpen
+  , withPopupContextVoid
+  , beginPopupContextVoid
+
+    -- ** Manual
   , openPopup
+  , openPopupOnItemClick
   , Raw.closeCurrentPopup
 
+    -- ** Queries
+  , isCurrentPopupOpen
+  , isAnyPopupOpen
+  , isAnyLevelPopupOpen
+
     -- * Item/Widgets Utilities
   , Raw.isItemHovered
   , Raw.wantCaptureMouse
@@ -264,6 +294,9 @@ module DearImGui
   , Raw.getForegroundDrawList
   , Raw.imCol32
 
+    -- * Plotting
+  , module DearImGui.Plot
+
     -- * Types
   , module DearImGui.Enums
   , module DearImGui.Structs
@@ -285,6 +318,7 @@ import System.IO
 -- dear-imgui
 import DearImGui.Enums
 import DearImGui.Structs
+import DearImGui.Plot
 import qualified DearImGui.Raw as Raw
 import qualified DearImGui.Raw.Font as Raw.Font
 import qualified DearImGui.Raw.ListClipper as Raw.ListClipper
@@ -1257,10 +1291,25 @@ treePush label = liftIO do
   withCString label Raw.treePush
 
 
--- | Wraps @ImGui::Selectable()@.
+-- | Wraps @ImGui::Selectable()@ with default options.
 selectable :: MonadIO m => String -> m Bool
-selectable label = liftIO do
+selectable = selectableWith defSelectableOptions
-  withCString label Raw.selectable
+
+data SelectableOptions = SelectableOptions
+                       { selected :: Bool
+                       , flags :: ImGuiSelectableFlags
+                       , size :: ImVec2
+                       } deriving Show
+
+defSelectableOptions :: SelectableOptions
+defSelectableOptions = SelectableOptions False (ImGuiSelectableFlags 0) (ImVec2 0 0)
+
+-- | Wraps @ImGui::Selectable()@ with explicit options.
+selectableWith :: MonadIO m => SelectableOptions -> String -> m Bool
+selectableWith (SelectableOptions selected flags size) label = liftIO do
+  with size $ \sizePtr ->
+    withCString label $ \labelPtr -> 
+      Raw.selectable labelPtr (bool 0 1 selected) flags sizePtr
 
 
 listBox :: (MonadIO m, HasGetter ref Int, HasSetter ref Int) => String -> ref -> [String] -> m Bool
@@ -1479,6 +1528,52 @@ withPopupModalOpen :: MonadUnliftIO m => String -> m () -> m ()
 withPopupModalOpen popupId action =
   withPopupModal popupId (`when` action)
 
+beginPopupContextItem :: MonadIO m => Maybe String -> ImGuiPopupFlags -> m Bool
+beginPopupContextItem itemId flags = liftIO do
+  withCStringOrNull itemId \popupIdPtr ->
+    Raw.beginPopupContextItem popupIdPtr flags
+
+withPopupContextItem :: MonadUnliftIO m => Maybe String -> ImGuiPopupFlags -> (Bool -> m a) -> m a
+withPopupContextItem popupId flags = bracket (beginPopupContextItem popupId flags) (`when` Raw.endPopup)
+
+withPopupContextItemOpen :: MonadUnliftIO m => Maybe String -> ImGuiPopupFlags -> m () -> m ()
+withPopupContextItemOpen popupId flags action = withPopupContextItem popupId flags (`when` action)
+
+-- | Attach item context popup to right mouse button click on a last item.
+itemContextPopup :: MonadUnliftIO m => m () -> m ()
+itemContextPopup = withPopupContextItemOpen Nothing ImGuiPopupFlags_MouseButtonRight
+
+beginPopupContextWindow :: MonadIO m => Maybe String -> ImGuiPopupFlags -> m Bool
+beginPopupContextWindow popupId flags = liftIO do
+  withCStringOrNull popupId \popupIdPtr ->
+    Raw.beginPopupContextWindow popupIdPtr flags
+
+withPopupContextWindow :: MonadUnliftIO m => Maybe String -> ImGuiPopupFlags -> (Bool -> m a) -> m a
+withPopupContextWindow popupId flags = bracket (beginPopupContextWindow popupId flags) (`when` Raw.endPopup)
+
+withPopupContextWindowOpen :: MonadUnliftIO m => Maybe String -> ImGuiPopupFlags -> m () -> m ()
+withPopupContextWindowOpen popupId flags action = withPopupContextWindow popupId flags (`when` action)
+
+-- | Attach item context popup to right mouse button click on a current window.
+windowContextPopup :: MonadUnliftIO m => m () -> m ()
+windowContextPopup = withPopupContextWindowOpen Nothing ImGuiPopupFlags_MouseButtonRight
+
+beginPopupContextVoid :: MonadIO m => Maybe String -> ImGuiPopupFlags -> m Bool
+beginPopupContextVoid popupId flags = liftIO do
+  withCStringOrNull popupId \popupIdPtr ->
+    Raw.beginPopupContextVoid popupIdPtr flags
+
+withPopupContextVoid :: MonadUnliftIO m => Maybe String -> ImGuiPopupFlags -> (Bool -> m a) -> m a
+withPopupContextVoid popupId flags = bracket (beginPopupContextVoid popupId flags) (`when` Raw.endPopup)
+
+withPopupContextVoidOpen :: MonadUnliftIO m => Maybe String -> ImGuiPopupFlags -> m () -> m ()
+withPopupContextVoidOpen popupId flags action = withPopupContextVoid popupId flags (`when` action)
+
+-- | Attach item context popup to right mouse button click outside of any windows.
+voidContextPopup :: MonadUnliftIO m => m () -> m ()
+voidContextPopup = withPopupContextWindowOpen Nothing ImGuiPopupFlags_MouseButtonRight
+
+
 -- | Call to mark popup as open (don't call every frame!).
 --
 -- Wraps @ImGui::OpenPopup()@
@@ -1486,6 +1581,37 @@ openPopup :: MonadIO m => String -> m ()
 openPopup popupId = liftIO do
   withCString popupId Raw.openPopup
 
+-- | Opens a defined popup (i.e. defined with 'withPopup') on defined action.
+--
+-- Example:
+--
+-- > openPopupOnItemClick "myPopup" ImGuiPopupFlags_MouseButtonRight
+--
+-- Wraps @ImGui::OpenPopup()@
+openPopupOnItemClick :: MonadIO m => String -> ImGuiPopupFlags -> m ()
+openPopupOnItemClick popupId flags = liftIO do
+  withCString popupId $ \idPtr ->
+    Raw.openPopupOnItemClick idPtr flags
+
+-- | Check if the popup is open at the current 'beginPopup' level of the popup stack.
+isCurrentPopupOpen :: MonadIO m => String -> m Bool
+isCurrentPopupOpen popupId = liftIO do
+  withCString popupId $ \idPtr ->
+    Raw.isPopupOpen idPtr ImGuiPopupFlags_None
+
+-- | Check if *any* popup is open at the current 'beginPopup' level of the popup stack.
+isAnyPopupOpen :: MonadIO m => String -> m Bool
+isAnyPopupOpen popupId = liftIO do
+  withCString popupId $ \idPtr ->
+    Raw.isPopupOpen idPtr ImGuiPopupFlags_AnyPopupId
+
+-- | Check if *any* popup is open at any level of the popup stack.
+isAnyLevelPopupOpen :: MonadIO m => String -> m Bool
+isAnyLevelPopupOpen popupId = liftIO do
+  withCString popupId $ \idPtr ->
+    Raw.isPopupOpen idPtr $
+      ImGuiPopupFlags_AnyPopupId .|. ImGuiPopupFlags_AnyPopupLevel
+
 
 withCStringOrNull :: Maybe String -> (Ptr CChar -> IO a) -> IO a
 withCStringOrNull Nothing k  = k nullPtr

src/DearImGui/Context.hs

@@ -43,3 +43,11 @@ imguiContext = mempty
       , ( TypeName "ImGuiListClipper", [t| ImGuiListClipper |] )
       ]
   }
+
+implotContext :: Context
+implotContext = mempty
+  { ctxTypesTable =
+    Map.fromList
+      [ ( TypeName "ImPlotContext", [t| ImPlotContext |] )
+      ]
+  }

src/DearImGui/Plot.hs

@@ -0,0 +1,71 @@
+{-# LANGUAGE BlockArguments #-}
+{-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE LambdaCase #-}
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE NamedFieldPuns #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE PatternSynonyms #-}
+{-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE TemplateHaskell #-}
+
+{-|
+Module: DearImGui.Plot
+
+Main ImPlot module, exporting the functions to make plots happen in Gui.
+-}
+
+module DearImGui.Plot
+  ( -- * Context Creation and Access
+    Raw.Plot.PlotContext(..)
+  , Raw.Plot.createPlotContext
+  , Raw.Plot.destroyPlotContext
+  , Raw.Plot.getCurrentPlotContext
+  , Raw.Plot.setCurrentPlotContext
+
+    -- * Demo so you can play with all features
+  , Raw.Plot.showPlotDemoWindow
+  )
+  where
+
+-- base
+import Control.Monad
+  ( when )
+import Data.Bool
+import Data.Foldable
+  ( foldl' )
+import Foreign
+import Foreign.C
+import qualified GHC.Foreign as Foreign
+import System.IO
+  ( utf8 )
+
+-- dear-imgui
+import DearImGui.Enums
+import DearImGui.Structs
+import qualified DearImGui.Raw as Raw
+import qualified DearImGui.Raw.Plot as Raw.Plot
+import qualified DearImGui.Raw.Font as Raw.Font
+import qualified DearImGui.Raw.ListClipper as Raw.ListClipper
+
+-- managed
+import qualified Control.Monad.Managed as Managed
+
+-- StateVar
+import Data.StateVar
+  ( HasGetter(get), HasSetter, ($=!) )
+
+-- transformers
+import Control.Monad.IO.Class
+  ( MonadIO, liftIO )
+
+-- unliftio
+import UnliftIO (MonadUnliftIO)
+import UnliftIO.Exception (bracket, bracket_)
+
+-- vector
+import qualified Data.Vector as V
+import qualified Data.Vector.Storable as VS
+import qualified Data.Vector.Unboxed as VU
+

src/DearImGui/Raw.hs

@@ -197,7 +197,12 @@ module DearImGui.Raw
   , beginPopupModal
   , endPopup
   , openPopup
+  , openPopupOnItemClick
   , closeCurrentPopup
+  , beginPopupContextItem
+  , beginPopupContextWindow
+  , beginPopupContextVoid
+  , isPopupOpen
 
     -- * ID stack/scopes
   , pushIDInt
@@ -1081,10 +1086,17 @@ treePop = liftIO do
   [C.exp| void { TreePop() } |]
 
 
+-- -- | Wraps @ImGui::Selectable()@.
+-- selectable :: (MonadIO m) => CString -> m Bool
+-- selectable labelPtr = liftIO do
+--   (0 /=) <$> [C.exp| bool { Selectable($(char* labelPtr)) } |]
+
+
 -- | Wraps @ImGui::Selectable()@.
-selectable :: (MonadIO m) => CString -> m Bool
+selectable :: (MonadIO m) => CString -> CBool -> ImGuiSelectableFlags -> Ptr ImVec2 -> m Bool
-selectable labelPtr = liftIO do
+selectable labelPtr selected flags size = liftIO do
-  (0 /=) <$> [C.exp| bool { Selectable($(char* labelPtr)) } |]
+  (0 /=) <$> [C.exp| bool { Selectable($(char* labelPtr), $(bool selected), $(ImGuiSelectableFlags flags), *$(ImVec2 *size)) } |]
+
 
 
 -- | Wraps @ImGui::ListBox()@.
@@ -1253,6 +1265,16 @@ openPopup popupIdPtr = liftIO do
   [C.exp| void { OpenPopup($(char* popupIdPtr)) } |]
 
 
+-- | Open popup when clicked on last item.
+--
+-- Note: actually triggers on the mouse _released_ event to be consistent with popup behaviors.
+--
+-- Wraps @ImGui::OpenPopupOnItemClick()@
+openPopupOnItemClick :: (MonadIO m) => CString -> ImGuiPopupFlags-> m ()
+openPopupOnItemClick popupIdPtr flags = liftIO do
+  [C.exp| void { OpenPopupOnItemClick($(char* popupIdPtr), $(ImGuiPopupFlags flags)) } |]
+
+
 -- | Manually close the popup we have begin-ed into.
 --
 -- Wraps @ImGui::ClosePopup()@
@@ -1260,6 +1282,36 @@ closeCurrentPopup :: (MonadIO m) => m ()
 closeCurrentPopup = liftIO do
   [C.exp| void { CloseCurrentPopup() } |]
 
+-- | Open+begin popup when clicked on last item.
+--
+-- Use str_id==NULL to associate the popup to previous item.
+--
+-- If you want to use that on a non-interactive item such as 'text' you need to pass in an explicit ID here.
+beginPopupContextItem :: (MonadIO m) => CString -> ImGuiPopupFlags-> m Bool
+beginPopupContextItem popupIdPtr flags = liftIO do
+  (0 /=) <$> [C.exp| bool { BeginPopupContextItem($(char* popupIdPtr), $(ImGuiPopupFlags flags)) } |]
+
+-- | Open+begin popup when clicked on current window.
+beginPopupContextWindow :: (MonadIO m) => CString -> ImGuiPopupFlags-> m Bool
+beginPopupContextWindow popupIdPtr flags = liftIO do
+  (0 /=) <$> [C.exp| bool { BeginPopupContextWindow($(char* popupIdPtr), $(ImGuiPopupFlags flags)) } |]
+
+-- | Open+begin popup when clicked in void (where there are no windows).
+beginPopupContextVoid :: (MonadIO m) => CString -> ImGuiPopupFlags-> m Bool
+beginPopupContextVoid popupIdPtr flags = liftIO do
+  (0 /=) <$> [C.exp| bool { BeginPopupContextVoid($(char* popupIdPtr), $(ImGuiPopupFlags flags)) } |]
+
+-- | Query popup status
+--
+-- - return 'True' if the popup is open at the current 'beginPopup' level of the popup stack.
+-- - with 'ImGuiPopupFlags_AnyPopupId': return 'True' if any popup is open at the current 'beginPopup' level of the popup stack.
+-- - with 'ImGuiPopupFlags_AnyPopupId' | 'ImGuiPopupFlags_AnyPopupLevel': return 'True' if any popup is open.
+--
+-- Wraps @ImGui::IsPopupOpen()@
+isPopupOpen :: (MonadIO m) => CString -> ImGuiPopupFlags-> m Bool
+isPopupOpen popupIdPtr flags = liftIO do
+  (0 /=) <$> [C.exp| bool { IsPopupOpen($(char* popupIdPtr), $(ImGuiPopupFlags flags)) } |]
+
 
 -- | Is the last item hovered? (and usable, aka not blocked by a popup, etc.).
 --

src/DearImGui/Raw/Plot.hs

@@ -0,0 +1,83 @@
+{-# LANGUAGE BlockArguments #-}
+{-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE LambdaCase #-}
+{-# LANGUAGE NamedFieldPuns #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE PatternSynonyms #-}
+{-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE TemplateHaskell #-}
+{-# LANGUAGE ViewPatterns #-}
+
+{-|
+Module: DearImGui.Raw.Plot
+
+Main ImPlot Raw module.
+-}
+module DearImGui.Raw.Plot 
+  ( PlotContext(..)
+  , createPlotContext
+  , destroyPlotContext
+  , getCurrentPlotContext
+  , setCurrentPlotContext
+
+  , showPlotDemoWindow
+  ) where
+
+-- base
+import Control.Monad.IO.Class
+  ( MonadIO, liftIO )
+import Foreign
+import Foreign.C
+import System.IO.Unsafe
+  ( unsafePerformIO )
+
+-- dear-imgui
+import DearImGui.Context
+  ( imguiContext, implotContext )
+import DearImGui.Enums
+import DearImGui.Structs
+import DearImGui.Raw.DrawList (DrawList(..))
+
+-- inline-c
+import qualified Language.C.Inline as C
+
+-- inline-c-cpp
+import qualified Language.C.Inline.Cpp as Cpp
+
+C.context (Cpp.cppCtx <> C.bsCtx <> imguiContext <> implotContext)
+C.include "imgui.h"
+C.include "implot.h"
+Cpp.using "namespace ImPlot"
+
+
+-- | Wraps @ImPlotContext*@.
+newtype PlotContext = PlotContext (Ptr ImPlotContext)
+
+
+-- | Wraps @ImPlot::CreateContext()@.
+createPlotContext :: (MonadIO m) => m PlotContext
+createPlotContext = liftIO do
+  PlotContext <$> [C.exp| ImPlotContext* { CreateContext() } |]
+
+-- | Wraps @ImPlot::DestroyPlotContext()@.
+destroyPlotContext :: (MonadIO m) => PlotContext -> m ()
+destroyPlotContext (PlotContext contextPtr) = liftIO do
+  [C.exp| void { DestroyContext($(ImPlotContext* contextPtr)); } |]
+
+-- | Wraps @ImPlot::GetCurrentPlotContext()@.
+getCurrentPlotContext :: MonadIO m => m PlotContext
+getCurrentPlotContext = liftIO do
+  PlotContext <$> [C.exp| ImPlotContext* { GetCurrentContext() } |]
+
+
+-- | Wraps @ImPlot::SetCurrentPlotContext()@.
+setCurrentPlotContext :: MonadIO m => PlotContext -> m ()
+setCurrentPlotContext (PlotContext contextPtr) = liftIO do
+  [C.exp| void { SetCurrentContext($(ImPlotContext* contextPtr)) } |]
+
+-- | Create demo window. Demonstrate most ImGui features. Call this to learn
+-- about the library! Try to make it always available in your application!
+showPlotDemoWindow :: (MonadIO m) => m ()
+showPlotDemoWindow = liftIO do
+  [C.exp| void { ShowDemoWindow(); } |]

src/DearImGui/Structs.hs

@@ -107,3 +107,23 @@ type ImWchar = Word32
 #else
 type ImWchar = Word16
 #endif
+
+--------------------------------------------------------------------------------
+
+-- | DearImPlot context handle
+data ImPlotContext
+
+-- |  Double precision version of ImVec2 used by ImPlot. Extensible by end users
+data ImPlotPoint
+
+-- | Range defined by a min/max value.
+data ImPlotRange
+
+-- | Combination of two range limits for X and Y axes. Also an AABB defined by Min()/Max().
+data ImPlotRect
+
+-- | Plot style structure
+data ImPlotStyle
+
+-- | Input mapping structure. Default values listed. See also MapInputDefault, MapInputReverse.
+data ImPlotInputMap