Merge branch 'main' into sharedLib

This change enables starting a new TreeNode open.

.gitmodules

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

ChangeLog.md

@@ -1,5 +1,26 @@
 # Changelog for dear-imgui
 
+## [2.1.1]
+
+- Build flag fix for MacOS.
+
+## [2.1.0]
+
+- `imgui` updated to [1.88].
+    * Breaking: `ImGuiKeyModFlags` renamed to `ImGuiModFlags`.
+
+## [2.0.0]
+
+- `String` arguments replaced with `Text`.
+  * Upgrading to `text-2` recommended to reap the UTF-8 benefits.
+
+## [1.5.0]
+
+- Added table wrappers.
+- Added popup wrappers.
+- Added `selectableWith`/`SelectableOptions` to expose optional arguments.
+- Fix GHC-9.2 compatibility.
+
 ## [1.4.0]
 
 - `imgui` updated to [1.87].
@@ -68,6 +89,10 @@ Initial Hackage release based on [1.83].
 [1.3.0]: https://github.com/haskell-game/dear-imgui.hs/tree/v1.3.0
 [1.3.1]: https://github.com/haskell-game/dear-imgui.hs/tree/v1.3.1
 [1.4.0]: https://github.com/haskell-game/dear-imgui.hs/tree/v1.4.0
+[1.5.0]: https://github.com/haskell-game/dear-imgui.hs/tree/v1.5.0
+[2.0.0]: https://github.com/haskell-game/dear-imgui.hs/tree/v2.0.0
+[2.1.0]: https://github.com/haskell-game/dear-imgui.hs/tree/v2.1.0
+[2.1.1]: https://github.com/haskell-game/dear-imgui.hs/tree/v2.1.1
 
 [1.87]: https://github.com/ocornut/imgui/releases/tag/v1.87
 [1.86]: https://github.com/ocornut/imgui/releases/tag/v1.86

Main.hs

@@ -10,6 +10,7 @@ import Data.IORef
 import qualified Data.Vector as Vector
 import DearImGui
 import DearImGui.OpenGL3
+import DearImGui.Internal.Text (pack)
 import DearImGui.SDL
 import DearImGui.SDL.OpenGL
 import Control.Exception
@@ -134,18 +135,18 @@ loop window checked color slider r pos size' selected tab1Ref tab2Ref = do
 
   text "ListClipper"
   withChildOpen "##fixed" (ImVec2 0 200) True ImGuiWindowFlags_None do
-    let lotsOfItems = Vector.generate 50 (mappend "Item " . show)
+    let lotsOfItems = Vector.generate 50 (pack . mappend "Item " . show)
     withListClipper Nothing lotsOfItems text
 
   text "ListClipper, Haskell-powered"
   withChildOpen "##infinite" (ImVec2 0 200) True ImGuiWindowFlags_None do
-    let infiniteItems = map (mappend "Item " . show) [0 :: Int ..]
+    let infiniteItems = map (pack . mappend "Item " . show) [0 :: Int ..]
     withListClipper Nothing infiniteItems text
 
   text "Ethereal ListClipper"
   withChildOpen "##ethereal" (ImVec2 0 200) True ImGuiWindowFlags_None do
     withListClipper Nothing (ClipRange (0 :: Int) 1000) $
-      text . mappend "Item " . show
+      text . pack . mappend "Item " . show
 
   plotHistogram "A histogram" [ 10, 10, 20, 30, 90 ]
 

dear-imgui.cabal

@@ -1,7 +1,7 @@
 cabal-version: 3.0
 
 name: dear-imgui
-version: 1.4.0
+version: 2.1.1
 author: Oliver Charles
 maintainer: ollie@ocharles.org.uk, aenor.realm@gmail.com
 license: BSD-3-Clause
@@ -13,18 +13,15 @@ description:
   Set package flags according to your needs.
 
 build-type: Simple
-extra-source-files:
-  README.md,
-  ChangeLog.md
 
 extra-source-files:
+  README.md,
+  ChangeLog.md,
   imgui/*.h,
   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)
@@ -128,6 +125,17 @@ flag use-wchar32
   manual:
     True
 
+flag use-ImDrawIdx32
+  description:
+    Use 32-bit vertex indices (default is 16-bit) is one way to allow large meshes with more than 64K vertices.
+    Your renderer backend will need to support it (most example renderer backends support both 16/32-bit indices).
+    Another way to allow large meshes while keeping 16-bit indices is to handle ImDrawCmd::VtxOffset in your renderer.
+    Read about ImGuiBackendFlags_RendererHasVtxOffset for details.
+  default:
+    True
+  manual:
+    True
+
 common common
   build-depends:
       base
@@ -139,22 +147,29 @@ library
   import: common
   hs-source-dirs:
     src
+    generator
   exposed-modules:
     DearImGui
     DearImGui.FontAtlas
-    DearImGui.Plot
+    DearImGui.Internal.Text
     DearImGui.Raw
     DearImGui.Raw.DrawList
     DearImGui.Raw.Font
     DearImGui.Raw.Font.Config
     DearImGui.Raw.Font.GlyphRanges
-    DearImGui.Raw.ListClipper
     DearImGui.Raw.IO
-    DearImGui.Raw.Plot
+    DearImGui.Raw.ListClipper
   other-modules:
     DearImGui.Context
     DearImGui.Enums
     DearImGui.Structs
+    DearImGui.Generator
+    DearImGui.Generator.Parser
+    DearImGui.Generator.Tokeniser
+    DearImGui.Generator.Types
+  ghc-options:
+    -static -dynamic-too
+    -- create both libHSdear-imgui... .a and .so
   cxx-options: -std=c++11
   cxx-sources:
     imgui/imgui.cpp
@@ -162,23 +177,51 @@ library
     imgui/imgui_draw.cpp
     imgui/imgui_tables.cpp
     imgui/imgui_widgets.cpp
-    implot/implot.cpp
+  install-includes:
-    implot/implot_demo.cpp
+    imgui.h
-    implot/implot_items.cpp
+    imgui_internal.h
+    imstb_rectpack.h
+    imstb_textedit.h
+    imstb_truetype.h
   extra-libraries:
     stdc++
   include-dirs:
     imgui
-    implot
   build-depends:
-      dear-imgui-generator
+      managed
-    , containers
-    , managed
-    , inline-c
     , inline-c-cpp
     , StateVar
     , unliftio
     , vector
+    -- for the generator:
+    , template-haskell
+        >= 2.15 && < 2.19
+    , containers
+       ^>= 0.6.2.1
+    , directory
+        >= 1.3 && < 1.4
+    , filepath
+        >= 1.4 && < 1.5
+    , inline-c
+        >= 0.9.0.0 && < 0.10
+    , megaparsec
+        >= 9.0 && < 9.3
+    , parser-combinators
+        >= 1.2.0 && < 1.4
+    , scientific
+        >= 0.3.6.2 && < 0.3.8
+    , text
+        >= 1.2.4 && < 2.1
+    , th-lift
+        >= 0.7 && < 0.9
+    , transformers
+        >= 0.5.6 && < 0.6
+    , unordered-containers
+        >= 0.2.11 && < 0.3
+
+  if os(darwin)
+    ghc-options:
+      -optcxx-std=c++11
 
   if flag(disable-obsolete)
     cxx-options: -DIMGUI_DISABLE_OBSOLETE_FUNCTIONS
@@ -187,6 +230,10 @@ library
     cxx-options: -DIMGUI_USE_WCHAR32
     cpp-options: -DIMGUI_USE_WCHAR32
 
+  if flag(use-ImDrawIdx32)
+    cxx-options: "-DImDrawIdx=unsigned int"
+    cpp-options: "-DImDrawIdx=unsigned int"
+
   if flag(opengl2)
     exposed-modules:
       DearImGui.OpenGL2
@@ -268,40 +315,6 @@ library
       exposed-modules:
         DearImGui.GLFW.Vulkan
 
-library dear-imgui-generator
-  import: common
-  hs-source-dirs: generator
-  exposed-modules:
-      DearImGui.Generator
-    , DearImGui.Generator.Parser
-    , DearImGui.Generator.Tokeniser
-    , DearImGui.Generator.Types
-  build-depends:
-      template-haskell
-        >= 2.15 && < 2.19
-    , containers
-       ^>= 0.6.2.1
-    , directory
-        >= 1.3 && < 1.4
-    , filepath
-        >= 1.4 && < 1.5
-    , inline-c
-        >= 0.9.0.0 && < 0.10
-    , megaparsec
-        >= 9.0 && < 9.3
-    , parser-combinators
-        >= 1.2.0 && < 1.4
-    , scientific
-        >= 0.3.6.2 && < 0.3.8
-    , text
-        >= 1.2.4 && < 1.3
-    , th-lift
-        >= 0.7 && < 0.9
-    , transformers
-        >= 0.5.6 && < 0.6
-    , unordered-containers
-        >= 0.2.11 && < 0.3
-
 executable test
   import: common, exe-flags
   main-is: Main.hs
@@ -319,7 +332,7 @@ executable glfw
   if (!flag(examples) || !flag(glfw) || !flag(opengl2))
     buildable: False
   else
-    build-depends: base, GLFW-b, gl, dear-imgui, managed
+    build-depends: base, GLFW-b, gl, dear-imgui, managed, text
 
 executable readme
   import: common, exe-flags

examples/glfw/Main.hs

@@ -1,6 +1,7 @@
 {-# language BlockArguments #-}
 {-# language LambdaCase #-}
 {-# language OverloadedStrings #-}
+{-# language RecordWildCards #-}
 
 module Main ( main ) where
 
@@ -8,6 +9,12 @@ import Control.Exception
 import Control.Monad
 import Control.Monad.IO.Class
 import Control.Monad.Managed
+import Data.Bits ((.|.))
+import Data.IORef
+import Data.List (sortBy)
+import Data.Foldable (traverse_)
+import Data.Text (Text, pack)
+
 import DearImGui
 import DearImGui.OpenGL2
 import DearImGui.GLFW
@@ -40,14 +47,23 @@ main = do
         -- Initialize ImGui's OpenGL backend
         _ <- managed_ $ bracket_ openGL2Init openGL2Shutdown
 
-        liftIO $ mainLoop win
+        tableRef <- liftIO $ newIORef
+          [ (1,  "foo")
+          , (2,  "bar")
+          , (3,  "baz")
+          , (10, "spam")
+          , (11, "spam")
+          , (12, "spam")
+          ]
+
+        liftIO $ mainLoop win tableRef
       Nothing -> do
         error "GLFW createWindow failed"
 
   GLFW.terminate
 
-mainLoop :: Window -> IO ()
+mainLoop :: Window -> IORef [(Integer, Text)] -> IO ()
-mainLoop win = do
+mainLoop win tableRef = do
   -- Process the event loop
   GLFW.pollEvents
   close <- GLFW.windowShouldClose win
@@ -73,8 +89,9 @@ mainLoop win = do
           when clicked $
             closeCurrentPopup
 
-    -- Show the ImGui demo window
+      newLine
-    showDemoWindow
+
+      mkTable tableRef
 
     -- Render
     glClear GL_COLOR_BUFFER_BIT
@@ -84,4 +101,41 @@ mainLoop win = do
 
     GLFW.swapBuffers win
 
-    mainLoop win
+    mainLoop win tableRef
+
+mkTable :: IORef [(Integer, Text)] -> IO ()
+mkTable tableRef =
+  withTableOpen sortable "MyTable" 3 $ do
+    tableSetupColumn "Hello"
+    tableSetupColumnWith defTableColumnOptions "World"
+
+    withSortableTable \isDirty sortSpecs ->
+      when (isDirty && not (null sortSpecs)) do
+        -- XXX: do your sorting & cache it. Dont sort every frame.
+        putStrLn "So dirty!"
+        print sortSpecs
+        modifyIORef' tableRef . sortBy $
+          foldMap mkCompare sortSpecs
+
+    tableHeadersRow
+    readIORef tableRef >>=
+      traverse_ \(ix, title) -> do
+        tableNextRow
+        tableNextColumn $ text (pack $ show ix)
+        tableNextColumn $ text title
+        tableNextColumn $ void (button "♥")
+  where
+    mkCompare TableSortingSpecs{..} a b =
+      let
+        dir = if tableSortingReverse then flip else id
+      in
+        case tableSortingColumn of
+          0 -> dir compare (fst a) (fst b)
+          1 -> dir compare (snd a) (snd b)
+          _ -> EQ
+
+    sortable = defTableOptions
+      { tableFlags =
+          ImGuiTableFlags_Sortable .|.
+          ImGuiTableFlags_SortMulti
+      }

examples/vulkan/Backend.hs

@@ -374,11 +374,10 @@ chooseSwapchainFormat
 
       case sortOn ( Down . score ) ( Boxed.Vector.toList surfaceFormats ) of
         [] -> error "No formats found."
-        ( best : _ )
+        Vulkan.SurfaceFormatKHR{format=Vulkan.FORMAT_UNDEFINED} : _rest ->
-          | Vulkan.FORMAT_UNDEFINED <- ( Vulkan.format :: Vulkan.SurfaceFormatKHR -> Vulkan.Format ) best
+          pure preferredFormat
-            -> pure preferredFormat
+        best : _rest
-          | otherwise
+          -> pure best
-            -> pure best
 
     where
       match :: Eq a => a -> a -> Int
@@ -415,11 +414,8 @@ createSwapchain physicalDevice device surface surfaceFormat imageUsage imageCoun
       | otherwise
       = Vulkan.PRESENT_MODE_FIFO_KHR
 
-    currentExtent :: Vulkan.Extent2D
+    Vulkan.SurfaceCapabilitiesKHR{currentExtent, currentTransform} = surfaceCapabilities
-    currentExtent = ( Vulkan.currentExtent :: Vulkan.SurfaceCapabilitiesKHR -> Vulkan.Extent2D ) surfaceCapabilities
+    Vulkan.SurfaceFormatKHR{format=fmt, colorSpace=csp} = surfaceFormat
-
-    currentTransform :: Vulkan.SurfaceTransformFlagBitsKHR
-    currentTransform = ( Vulkan.currentTransform :: Vulkan.SurfaceCapabilitiesKHR -> Vulkan.SurfaceTransformFlagBitsKHR ) surfaceCapabilities
 
     swapchainCreateInfo :: Vulkan.SwapchainCreateInfoKHR '[]
     swapchainCreateInfo =
@@ -428,8 +424,8 @@ createSwapchain physicalDevice device surface surfaceFormat imageUsage imageCoun
         , Vulkan.flags                 = Vulkan.zero
         , Vulkan.surface               = Vulkan.SurfaceKHR surface
         , Vulkan.minImageCount         = imageCount
-        , Vulkan.imageFormat           = ( Vulkan.format     :: Vulkan.SurfaceFormatKHR -> Vulkan.Format        ) surfaceFormat
+        , Vulkan.imageFormat           = fmt
-        , Vulkan.imageColorSpace       = ( Vulkan.colorSpace :: Vulkan.SurfaceFormatKHR -> Vulkan.ColorSpaceKHR ) surfaceFormat
+        , Vulkan.imageColorSpace       = csp
         , Vulkan.imageExtent           = currentExtent
         , Vulkan.imageArrayLayers      = 1
         , Vulkan.imageUsage            = imageUsage
@@ -591,7 +587,7 @@ createFramebuffer
   -> Vulkan.Extent2D
   -> f Vulkan.ImageView
   -> m ( ResourceT.ReleaseKey, Vulkan.Framebuffer )
-createFramebuffer dev renderPass extent attachments = Vulkan.withFramebuffer dev createInfo Nothing ResourceT.allocate
+createFramebuffer dev renderPass Vulkan.Extent2D{width, height} attachments = Vulkan.withFramebuffer dev createInfo Nothing ResourceT.allocate
   where
     createInfo :: Vulkan.FramebufferCreateInfo '[]
     createInfo =
@@ -600,8 +596,8 @@ createFramebuffer dev renderPass extent attachments = Vulkan.withFramebuffer dev
         , Vulkan.flags       = Vulkan.zero
         , Vulkan.renderPass  = renderPass
         , Vulkan.attachments = Boxed.Vector.fromList . toList $ attachments
-        , Vulkan.width       = ( Vulkan.width  :: Vulkan.Extent2D -> Word32 ) extent
+        , Vulkan.width       = width
-        , Vulkan.height      = ( Vulkan.height :: Vulkan.Extent2D -> Word32 ) extent
+        , Vulkan.height      = height
         , Vulkan.layers      = 1
         }
 

examples/vulkan/Main.hs

@@ -201,9 +201,7 @@ app = do
   surfaceCapabilities <- Vulkan.getPhysicalDeviceSurfaceCapabilitiesKHR physicalDevice ( Vulkan.SurfaceKHR surface )
 
   let
-    minImageCount, maxImageCount, imageCount :: Word32
+    Vulkan.SurfaceCapabilitiesKHR{minImageCount, maxImageCount} = surfaceCapabilities
-    minImageCount = ( Vulkan.minImageCount :: Vulkan.SurfaceCapabilitiesKHR -> Word32 ) surfaceCapabilities
-    maxImageCount = ( Vulkan.maxImageCount :: Vulkan.SurfaceCapabilitiesKHR -> Word32 ) surfaceCapabilities
     imageCount
       | maxImageCount == 0 =   minImageCount + 1
       | otherwise          = ( minImageCount + 1 ) `min` maxImageCount
@@ -213,31 +211,30 @@ app = do
 
     swapchainResources :: Maybe SwapchainResources -> m ( m (), SwapchainResources )
     swapchainResources mbOldResources = do
-      ( surfaceFormat, imGuiRenderPass ) <- case mbOldResources of
+      ( colFmt, surfaceFormat, imGuiRenderPass ) <- case mbOldResources of
         Nothing -> do
           logDebug "Choosing swapchain format & color space"
           surfaceFormat <- chooseSwapchainFormat preferredFormat physicalDevice surface
-          let
+          let Vulkan.SurfaceFormatKHR{format=colFmt} = surfaceFormat
-            colFmt :: Vulkan.Format
-            colFmt = ( Vulkan.format :: Vulkan.SurfaceFormatKHR -> Vulkan.Format ) surfaceFormat
           logDebug "Creating Dear ImGui render pass"
           ( _, imGuiRenderPass ) <-
             simpleRenderPass device
               ( noAttachments
                 { colorAttachments = Boxed.Vector.singleton $ presentableColorAttachmentDescription colFmt }
               )
-          pure ( surfaceFormat, imGuiRenderPass )
+          pure ( colFmt, surfaceFormat, imGuiRenderPass )
-        Just oldResources -> pure ( surfaceFormat oldResources, imGuiRenderPass oldResources )
+        Just oldResources -> do
-
+          let surFmt = surfaceFormat oldResources
-      let
+          let Vulkan.SurfaceFormatKHR{format=colFmt} = surFmt
-        colFmt :: Vulkan.Format
+          pure ( colFmt, surFmt, imGuiRenderPass oldResources )
-        colFmt = ( Vulkan.format :: Vulkan.SurfaceFormatKHR -> Vulkan.Format ) surfaceFormat
 
       logDebug "Creating swapchain"
       ( swapchainKey, swapchain, swapchainExtent ) <-
         createSwapchain
-          physicalDevice device
+          physicalDevice
-          surface surfaceFormat
+          device
+          surface
+          surfaceFormat
           surfaceUsage
           imageCount
           ( swapchain <$> mbOldResources )

generator/DearImGui/Generator.hs

@@ -24,6 +24,10 @@ import Data.Traversable
   ( for )
 import Foreign.Storable
   ( Storable )
+#if MIN_VERSION_template_haskell(2,18,0)
+import Data.Coerce
+  ( coerce )
+#endif
 
 -- containers
 import Data.Map.Strict
@@ -74,15 +78,9 @@ headers = $( do
   basicHeaders <- TH.runIO do
     headersPath  <- canonicalizePath ( takeDirectory currentPath <> "/../../imgui/imgui.h" )
     headersSource <- Text.readFile headersPath
-    tokensImGui <- case tokenise headersSource of
+    tokens <- 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
@@ -177,7 +175,7 @@ declareEnumeration finiteEnumName countName ( Enumeration {..} ) = do
         else
           \ nm args dir pat ->
           TH.patSynD_doc nm args dir pat
-            ( Just $ Text.unpack patDoc ) []
+            ( Just $ Text.unpack _patDoc ) []
       )
 #else
       TH.patSynD

src/DearImGui/Context.hs

@@ -34,6 +34,7 @@ imguiContext = mempty
       , ( TypeName "ImVec3", [t| ImVec3 |] )
       , ( TypeName "ImVec4", [t| ImVec4 |] )
       , ( TypeName "ImU32", [t| ImU32 |] )
+      , ( TypeName "ImGuiID", [t| ImGuiID |] )
       , ( TypeName "ImWchar", [t| ImWchar |] )
       , ( TypeName "ImDrawList", [t| ImDrawList |] )
       , ( TypeName "ImGuiContext", [t| ImGuiContext |] )
@@ -41,13 +42,6 @@ imguiContext = mempty
       , ( TypeName "ImFontConfig", [t| ImFontConfig |] )
       , ( TypeName "ImFontGlyphRangesBuilder", [t| ImFontGlyphRangesBuilder |] )
       , ( TypeName "ImGuiListClipper", [t| ImGuiListClipper |] )
-      ]
+      , ( TypeName "ImGuiTableSortSpecs", [t| ImGuiTableSortSpecs |] )
-  }
-
-implotContext :: Context
-implotContext = mempty
-  { ctxTypesTable =
-    Map.fromList
-      [ ( TypeName "ImPlotContext", [t| ImPlotContext |] )
       ]
   }

src/DearImGui/FontAtlas.hs

@@ -119,6 +119,8 @@ import DearImGui.Raw.Font.Config (FontConfig(..))
 import qualified DearImGui.Raw.Font.Config as FontConfig
 import DearImGui.Raw.Font.GlyphRanges (GlyphRanges(..), GlyphRangesBuilder(..))
 import qualified DearImGui.Raw.Font.GlyphRanges as GlyphRanges
+import DearImGui.Internal.Text (Text)
+import qualified DearImGui.Internal.Text as Text
 
 import DearImGui.Structs (ImVec2(..), ImWchar)
 
@@ -332,10 +334,10 @@ addChar char =
     GlyphRanges.addChar builder char
 
 -- | UTF-8 string
-addText :: String -> RangesBuilderSetup
+addText :: Text -> RangesBuilderSetup
 addText str =
   RangesBuilderSetup \builder ->
-    withCString str (GlyphRanges.addText builder)
+    Text.withCString str (GlyphRanges.addText builder)
 
 -- | Existing ranges (as is)
 addRangesRaw :: GlyphRanges -> RangesBuilderSetup

src/DearImGui/Internal/Text.hs

@@ -0,0 +1,72 @@
+{-# LANGUAGE CPP #-}
+
+module DearImGui.Internal.Text
+  ( withCString
+  , withCStringOrNull
+  , withCStringLen
+  , withCStringEnd
+  , peekCString
+
+  , Text
+  , pack
+  , unpack
+  ) where
+
+-- base
+import Control.Monad.IO.Class (liftIO)
+import Foreign (nullPtr, plusPtr)
+import Foreign.C.String (CString)
+import qualified GHC.Foreign as Foreign
+import System.IO (utf8)
+
+-- text
+import Data.Text (Text, pack, unpack)
+import Data.Text.Foreign (withCStringLen)
+
+-- unliftio-core
+import UnliftIO (MonadUnliftIO, UnliftIO(..), withUnliftIO)
+
+#if MIN_VERSION_text(2,0,0)
+
+import Data.Text.Foreign (lengthWord8, unsafeCopyToPtr)
+import Data.Word (Word8)
+import Foreign (castPtr, free, mallocBytes, pokeByteOff)
+import UnliftIO.Exception (bracket)
+
+withCString :: MonadUnliftIO m => Text -> (CString -> m a) -> m a
+withCString t = bracket create destroy
+  where
+    size0 = lengthWord8 t + 1
+
+    create = liftIO $ do
+      ptr <- mallocBytes size0
+      unsafeCopyToPtr t (castPtr ptr)
+      pokeByteOff ptr size0 (0 :: Word8)
+      pure ptr
+
+    destroy ptr =
+      liftIO $ free ptr
+
+#else
+
+withCString :: MonadUnliftIO m => Text -> (CString -> m a) -> m a
+withCString t action = do
+  withUnliftIO $ \(UnliftIO unlift) ->
+    liftIO $
+      Foreign.withCString utf8 (unpack t) $ \textPtr ->
+        unlift $ action textPtr
+
+#endif
+
+peekCString :: CString -> IO Text
+peekCString = fmap pack . Foreign.peekCString utf8
+
+withCStringOrNull :: Maybe Text -> (CString -> IO a) -> IO a
+withCStringOrNull Nothing k  = k nullPtr
+withCStringOrNull (Just s) k = withCString s k
+
+withCStringEnd :: MonadUnliftIO m => Text -> (CString -> CString -> m a) -> m a
+withCStringEnd t action =
+  withUnliftIO $ \(UnliftIO unlift) ->
+    withCStringLen t $ \(textPtr, size) ->
+      unlift $ action textPtr (textPtr `plusPtr` size)

src/DearImGui/Plot.hs

@@ -1,71 +0,0 @@
-{-# 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

@@ -6,6 +6,7 @@
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE PatternSynonyms #-}
 {-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE ViewPatterns #-}
 
@@ -157,10 +158,34 @@ module DearImGui.Raw
   , colorPicker3
   , colorButton
 
+    -- * Tables
+  , beginTable
+  , endTable
+  , tableNextRow
+  , tableNextColumn
+  , tableSetColumnIndex
+
+  , tableSetupColumn
+  , tableSetupScrollFreeze
+  , tableHeadersRow
+  , tableHeader
+
+  , tableGetSortSpecs
+  , tableClearSortSpecsDirty
+
+  , tableGetColumnCount
+  , tableGetColumnIndex
+  , tableGetRowIndex
+  , tableGetColumnName
+  , tableGetColumnFlags
+  , tableSetColumnEnabled
+  , tableSetBgColor
+
     -- * Trees
   , treeNode
   , treePush
   , treePop
+  , setNextItemOpen
 
     -- ** Selectables
   , selectable
@@ -169,6 +194,7 @@ module DearImGui.Raw
   , listBox
 
     -- * Data Plotting
+  , plotLines
   , plotHistogram
 
     -- ** Menus
@@ -1068,6 +1094,128 @@ colorButton descPtr refPtr = liftIO do
   (0 /=) <$> [C.exp| bool { ColorButton( $(char* descPtr), *$(ImVec4* refPtr) ) } |]
 
 
+-- | Wraps @ImGui::BeginTable()@.
+beginTable :: MonadIO m => CString -> CInt -> ImGuiTableFlags -> Ptr ImVec2 -> CFloat -> m Bool
+beginTable labelPtr column flags outerSizePtr innerWidth = liftIO do
+  (0 /=) <$> [C.exp| bool { BeginTable($(char* labelPtr), $(int column), $(ImGuiTableFlags flags), *$(ImVec2* outerSizePtr), $(float innerWidth)) } |]
+
+-- | Only call 'endTable' if 'beginTable' returns true!
+--
+-- Wraps @ImGui::EndTable()@.
+endTable :: MonadIO m => m ()
+endTable = liftIO do
+  [C.exp| void { EndTable() } |]
+
+-- | Wraps @ImGui::TableNextRow()@.
+--   append into the first cell of a new row.
+tableNextRow :: MonadIO m => ImGuiTableRowFlags -> CFloat -> m ()
+tableNextRow flags minRowHeight = liftIO do
+  [C.exp| void { TableNextRow($(ImGuiTableRowFlags flags), $(float minRowHeight)) } |]
+
+-- | Wraps @ImGui::TableNextColumn()@.
+--   append into the next column (or first column of next row if currently in
+--   last column). Return true when column is visible.
+tableNextColumn :: MonadIO m => m Bool
+tableNextColumn = liftIO do
+  (0 /=) <$> [C.exp| bool { TableNextColumn() } |]
+
+-- | Wraps @ImGui::TableSetColumnIndex()@.
+--   append into the specified column. Return true when column is visible.
+tableSetColumnIndex :: MonadIO m => CInt -> m Bool
+tableSetColumnIndex column= liftIO do
+  (0 /=) <$> [C.exp| bool { TableSetColumnIndex($(int column)) } |]
+
+-- | Wraps @ImGui::TableSetupColumn()@.
+tableSetupColumn :: MonadIO m => CString -> ImGuiTableColumnFlags -> CFloat -> ImGuiID-> m ()
+tableSetupColumn labelPtr flags initWidthOrWeight userId = liftIO do
+  [C.exp| void { TableSetupColumn($(char* labelPtr), $(ImGuiTableColumnFlags flags), $(float initWidthOrWeight), $(ImGuiID userId)) } |]
+
+-- | Wraps @ImGui::TableSetupScrollFreeze()@.
+tableSetupScrollFreeze :: MonadIO m => CInt -> CInt -> m ()
+tableSetupScrollFreeze cols rows = liftIO do
+  [C.exp| void { TableSetupScrollFreeze($(int cols), $(int rows)) } |]
+
+-- | Wraps @ImGui::TableHeadersRow()@.
+--   submit all headers cells based on data provided to 'tableSetupColumn'
+--   + submit context menu
+tableHeadersRow :: MonadIO m => m ()
+tableHeadersRow = liftIO do
+  [C.exp| void { TableHeadersRow() } |]
+
+-- | Wraps @ImGui::TableHeader()@.
+--   submit one header cell manually (rarely used)
+tableHeader :: MonadIO m => CString -> m ()
+tableHeader labelPtr = liftIO do
+  [C.exp| void { TableHeader($(char* labelPtr)) } |]
+
+-- | Wraps @ImGui::TableGetSortSpecs()@.
+--   Low-level-Function. Better use the wrapper that outomatically conform
+--   to the things described below
+--
+--   Tables: Sorting
+--   - Call TableGetSortSpecs() to retrieve latest sort specs for the table.
+--     NULL when not sorting.
+--   - When 'SpecsDirty == true' you should sort your data. It will be true when
+--     sorting specs have changed since last call, or the first time. Make sure
+--     to set 'SpecsDirty = false' after sorting, else you may wastefully sort
+--     your data every frame!
+--   - Lifetime: don't hold on this pointer over multiple frames or past any
+--     subsequent call to BeginTable().
+tableGetSortSpecs :: MonadIO m => m (Maybe (Ptr ImGuiTableSortSpecs))
+tableGetSortSpecs = liftIO do
+  ptr <- [C.exp| ImGuiTableSortSpecs* { TableGetSortSpecs() } |]
+  if ptr == nullPtr then
+    return Nothing
+  else
+    return $ Just ptr
+
+tableClearSortSpecsDirty :: MonadIO m => Ptr ImGuiTableSortSpecs -> m ()
+tableClearSortSpecsDirty specsPtr = liftIO do
+  [C.block| void {
+    $(ImGuiTableSortSpecs* specsPtr)->SpecsDirty = false;
+  } |]
+
+-- | Wraps @ImGui::TableGetColumnCount()@.
+tableGetColumnCount :: MonadIO m => m CInt
+tableGetColumnCount = liftIO do
+  [C.exp| int { TableGetColumnCount() } |]
+
+-- | Wraps @ImGui::TableGetColumnIndex()@.
+tableGetColumnIndex :: MonadIO m => m CInt
+tableGetColumnIndex = liftIO do
+  [C.exp| int { TableGetColumnIndex() } |]
+
+-- | Wraps @ImGui::TableGetRowIndex()@.
+tableGetRowIndex :: MonadIO m => m CInt
+tableGetRowIndex = liftIO do
+  [C.exp| int { TableGetRowIndex() } |]
+
+-- | Wraps @ImGui::TableGetColumnName
+--   'Nothing' returns the current column name
+tableGetColumnName :: MonadIO m => Maybe CInt -> m CString
+tableGetColumnName Nothing = tableGetColumnName (Just (-1))
+tableGetColumnName (Just column_n) = liftIO do
+  [C.exp| const char* { TableGetColumnName($(int column_n)) } |]
+
+-- | Wraps @ImGui::TableGetRowIndex()@.
+--   'Nothing' returns the current column flags
+tableGetColumnFlags :: MonadIO m => Maybe CInt -> m ImGuiTableColumnFlags
+tableGetColumnFlags Nothing = tableGetColumnFlags (Just (-1))
+tableGetColumnFlags (Just column_n) = liftIO do
+  [C.exp| ImGuiTableColumnFlags { TableGetColumnFlags($(int column_n)) } |]
+
+-- | Wraps @ImGui::TableSetColumnEnabled()@.
+tableSetColumnEnabled :: MonadIO m => CInt -> CBool -> m ()
+tableSetColumnEnabled column_n v = liftIO do
+  [C.exp| void { TableSetColumnEnabled($(int column_n), $(bool v)) } |]
+
+-- | Wraps @ImGui::TableSetBgColor()@.
+--   'Nothing' sets the current row/column color
+tableSetBgColor :: MonadIO m => ImGuiTableBgTarget -> ImU32 -> Maybe CInt -> m ()
+tableSetBgColor target color Nothing = tableSetBgColor target color (Just (-1))
+tableSetBgColor target color (Just column_n) = liftIO do
+  [C.exp| void { TableSetBgColor($(ImGuiTableBgTarget target), $(ImU32 color), $(int column_n)) } |]
+
 -- | Wraps @ImGui::TreeNode()@.
 treeNode :: (MonadIO m) => CString -> m Bool
 treeNode labelPtr = liftIO do
@@ -1086,6 +1234,11 @@ treePop = liftIO do
   [C.exp| void { TreePop() } |]
 
 
+-- | Wraps @ImGui::SetNextItemOpen()@.
+setNextItemOpen :: (MonadIO m) => CBool -> m ()
+setNextItemOpen is_open = liftIO do
+  [C.exp| void { SetNextItemOpen($(bool is_open)) } |]
+
 -- -- | Wraps @ImGui::Selectable()@.
 -- selectable :: (MonadIO m) => CString -> m Bool
 -- selectable labelPtr = liftIO do
@@ -1104,6 +1257,10 @@ listBox :: (MonadIO m) => CString -> Ptr CInt -> Ptr CString -> CInt -> m Bool
 listBox labelPtr iPtr itemsPtr itemsLen = liftIO do
   (0 /=) <$> [C.exp| bool { ListBox($(char* labelPtr), $(int* iPtr), $(char** itemsPtr), $(int itemsLen)) }|]
 
+-- | Wraps @ImGui::PlotLines()@.
+plotLines :: (MonadIO m) => CString -> Ptr CFloat -> CInt -> m ()
+plotLines labelPtr valuesPtr valuesLen = liftIO do
+  [C.exp| void { PlotLines($(char* labelPtr), $(float* valuesPtr), $(int valuesLen)) } |]
 
 -- | Wraps @ImGui::PlotHistogram()@.
 plotHistogram :: (MonadIO m) => CString -> Ptr CFloat -> CInt -> m ()

src/DearImGui/Raw/Plot.hs

@@ -1,83 +0,0 @@
-{-# 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

@@ -1,5 +1,6 @@
 {-# LANGUAGE DuplicateRecordFields #-}
 {-# LANGUAGE NamedFieldPuns #-}
+{-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE CPP #-}
 
 module DearImGui.Structs where
@@ -13,7 +14,12 @@ import Data.Word
   )
 
 import Foreign
-  ( Storable(..), castPtr, plusPtr )
+  ( Storable(..), castPtr, plusPtr, Ptr, Int16, nullPtr )
+import Foreign.C
+  ( CInt, CBool )
+
+import DearImGui.Enums
+import Data.Bits ((.&.))
 
 --------------------------------------------------------------------------------
 data ImVec2 = ImVec2 { x, y :: {-# unpack #-} !Float }
@@ -98,9 +104,15 @@ data ImDrawList
 -- | 'DearImGui.Raw.ListClipper.ListClipper' pointer tag.
 data ImGuiListClipper
 
+-- | A unique ID used by widgets (typically the result of hashing a stack of string)
+--   unsigned Integer (same as ImU32)
+type ImGuiID = ImU32
+
 -- | 32-bit unsigned integer (often used to store packed colors).
 type ImU32 = Word32
 
+type ImS16 = Int16
+
 -- | Single wide character (used mostly in glyph management)
 #ifdef IMGUI_USE_WCHAR32
 type ImWchar = Word32
@@ -110,20 +122,93 @@ type ImWchar = Word16
 
 --------------------------------------------------------------------------------
 
--- | DearImPlot context handle
+-- | Sorting specifications for a table (often handling sort specs for a single column, occasionally more)
-data ImPlotContext
+--   Obtained by calling TableGetSortSpecs().
+--   When @SpecsDirty == true@ you can sort your data. It will be true with sorting specs have changed since last call, or the first time.
+--   Make sure to set @SpecsDirty = false@ after sorting, else you may wastefully sort your data every frame!
+data ImGuiTableSortSpecs = ImGuiTableSortSpecs
+  { specs      :: Ptr ImGuiTableColumnSortSpecs
+  , specsCount :: CInt
+  , specsDirty :: CBool
+  } deriving (Show, Eq)
 
--- |  Double precision version of ImVec2 used by ImPlot. Extensible by end users
+instance Storable ImGuiTableSortSpecs where
-data ImPlotPoint
+  sizeOf _ =
+    sizeOf (undefined :: Ptr ImGuiTableColumnSortSpecs) +
+    sizeOf (undefined :: CInt) +
+    sizeOf (undefined :: CBool)
 
--- | Range defined by a min/max value.
+  alignment _ =
-data ImPlotRange
+    alignment nullPtr
 
--- | Combination of two range limits for X and Y axes. Also an AABB defined by Min()/Max().
+  poke ptr ImGuiTableSortSpecs{..} = do
-data ImPlotRect
+    let specsPtr = castPtr ptr
+    poke specsPtr specs
 
--- | Plot style structure
+    let specsCountPtr = castPtr $ specsPtr `plusPtr` sizeOf specs
-data ImPlotStyle
+    poke specsCountPtr specsCount
 
--- | Input mapping structure. Default values listed. See also MapInputDefault, MapInputReverse.
+    let specsDirtyPtr = castPtr $ specsCountPtr `plusPtr` sizeOf specsCount
-data ImPlotInputMap
+    poke specsDirtyPtr specsDirty
+
+  peek ptr = do
+    let specsPtr = castPtr ptr
+    specs <- peek specsPtr
+
+    let specsCountPtr = castPtr $ specsPtr `plusPtr` sizeOf specs
+    specsCount <- peek specsCountPtr
+
+    let specsDirtyPtr = castPtr $ specsCountPtr `plusPtr` sizeOf specsCount
+    specsDirty <- peek specsDirtyPtr
+
+    pure ImGuiTableSortSpecs{..}
+
+-- | Sorting specification for one column of a table
+data ImGuiTableColumnSortSpecs = ImGuiTableColumnSortSpecs
+  { columnUserID  :: ImGuiID            -- ^ User id of the column (if specified by a TableSetupColumn() call)
+  , columnIndex   :: ImS16              -- ^ Index of the column
+  , sortOrder     :: ImS16              -- ^ Index within parent ImGuiTableSortSpecs (always stored in order starting from 0, tables sorted on a single criteria will always have a 0 here)
+  , sortDirection :: ImGuiSortDirection -- ^ 'ImGuiSortDirection_Ascending' or 'ImGuiSortDirection_Descending'
+  } deriving (Show, Eq)
+
+instance Storable ImGuiTableColumnSortSpecs where
+  sizeOf _ = 12
+  alignment _ = 4
+
+  poke ptr ImGuiTableColumnSortSpecs{..} = do
+    let columnUserIDPtr = castPtr ptr
+    poke columnUserIDPtr columnUserID
+
+    let columnIndexPtr = castPtr $ columnUserIDPtr `plusPtr` sizeOf columnUserID
+    poke columnIndexPtr columnIndex
+
+    let sortOrderPtr = castPtr $ columnIndexPtr `plusPtr` sizeOf columnIndex
+    poke sortOrderPtr sortOrder
+
+    let sortDirectionPtr = castPtr $ sortOrderPtr `plusPtr` sizeOf sortOrder
+    poke sortDirectionPtr sortDirection
+
+  peek ptr = do
+    let columnUserIDPtr = castPtr ptr
+    columnUserID <- peek columnUserIDPtr
+
+    let columnIndexPtr = castPtr $ columnUserIDPtr `plusPtr` sizeOf columnUserID
+    columnIndex <- peek columnIndexPtr
+
+    let sortOrderPtr = castPtr $ columnIndexPtr `plusPtr` sizeOf columnIndex
+    sortOrder <- peek sortOrderPtr
+
+    let sortDirectionPtr = castPtr $ sortOrderPtr `plusPtr` sizeOf sortOrder
+    sortDirection' <- peek sortDirectionPtr :: IO CInt
+    -- XXX: Specs struct uses trimmed field: @SortDirection : 8@
+    let sortDirection = case sortDirection' .&. 0xFF of
+          0 ->
+            ImGuiSortDirection_None
+          1 ->
+            ImGuiSortDirection_Ascending
+          2 ->
+            ImGuiSortDirection_Descending
+          _ ->
+            error $ "Unexpected value for ImGuiSortDirection: " <> show sortDirection
+
+    pure ImGuiTableColumnSortSpecs{..}