Add multi argument callback helpers. #77

crocket · 2016-10-29T02:32:33Z

This pull request does several things.

It makes sure that line widths don't exceed 80 in GHCJS/Foreign/Callback.hs
It adds jsbits/callback.js which contains h$makeCallbackMulti.
It adds GHCJS/Foreign/Callback/Variadic.hs which enables polyvariadic callback functions.
It adds syncCallbackMulti, syncCallbackMulti', and asyncCallbackMulti to
GHCJS/Foreign/Callback.hs. These functions utilize h$makeCallbackMulti and VariadicCallback for convenience of users. Refer to README for details.
It bumps up the version to 0.2.1.0
It documents OnBlocked and syncCallback' more clearly on README.
It documents syncCallbackMulti, syncCallbackMulti', and
asyncCallbackMulti on README.

I tested syncCallbackMulti, syncCallbackMulti', and asyncCallbackMulti
against the NodeJS example I included in README, and the functions worked well in my example.

This closes #76

It doesn't break existing functions.
Thus, I want this pull request to be merged as soon as possible if maintainers don't have major objections.

This commit does several things. * It makes sure that line widths don't exceed 80 in GHCJS/Foreign/Callback.hs * It adds jsbits/callback.js which contains h$makeCallbackMulti. * It adds syncCallbackMulti, syncCallbackMulti', and asyncCallbackMulti to GHCJS/Foreign/Callback.hs. These functions utilize h$makeCallbackMulti. * It bumps up the version to 0.2.1.0 * It documents `OnBlocked` and `syncCallback'` more clearly on README. * It documents syncCallbackMulti, syncCallbackMulti', and asyncCallbackMulti on README. I tested syncCallbackMulti, syncCallbackMulti', and asyncCallbackMulti in the NodeJS example I included in README.

It interchanges a section on a callback example with a section on multi-argument callbacks

README now shows an example of using `syncCallbackMulti'` instead of `asyncCallbackMulti`.

hamishmack · 2016-10-29T03:43:04Z

GHCJS/Foreign/Callback.hs

-asyncCallback1 :: (JSVal -> IO ())            -- ^ the function that the callback calls
-               -> IO (Callback (JSVal -> IO ())) -- ^ the calback
+asyncCallback1 :: (JSVal -> IO ()) -- the function that the callback calls
+               -> IO (Callback (JSVal -> IO ())) -- the calback


oops. I don't think you meant to remove the haddock markup cues

Sorry, I haven't learned haddock, yet. I'll restore haddock markup cues. I thought they were mere visual cues.

hamishmack · 2016-10-29T03:59:46Z

LGTM

I made a mistake of removing haddock markup cues because I still don't know how to use haddock.

crocket · 2016-10-31T14:14:37Z

@hamishmack Would it be ok to replace JavaScript.Array.toListIO :: SomeJSArray m -> IO [JSVal] with GHCJS.Prim.fromJSArray :: JSVal -> IO [JSVal] in my multi-argument callback functions? I presented the definition of syncCallbackMulti below to facilitate discussion.

{- | Make a callback (JavaScript function) that runs the supplied IO function
     in a synchronous thread when called. The callback takes an arbitrary
     number of arguments that it passes as an array of JSVal values to the
     Haskell function.
     Call 'releaseCallback' on the callback when done with the callback,
     freeing data referenced by the function.
 -}
syncCallbackMulti :: OnBlocked -- ^ what to do when the thread blocks
                  -> ([JSVal] -> IO ()) -- ^ the Haskell action
                  -> IO (Callback ([JSVal] -> IO ())) -- ^ the callback
syncCallbackMulti onBlocked f = do
  js_syncCallbackMulti (onBlocked == ContinueAsync) $ unsafeCoerce $ \args ->
    Array.toListIO (unsafeCoerce args) >>= f

Update 1. the above function is now gone. The functions are now replaced with polyvariadic variants.

hamishmack · 2016-11-01T00:29:13Z

I think it would be fine.

Replace JavaScript.Array.toListIO with GHCJS.Prim.fromJSArray in GHCJS/Foreign/Callback.hs

Previously, they were cumbersome to use. Now, they are a lot easier to use.

crocket · 2016-11-09T00:26:35Z

@hamishmack @luite I think the pull request is ready for merge. I request that a tag, v0.2.1.0 be added to the git repository after merging this pull request. Is it ok for you to do so?

ToArrayCallback was difficult to understand and use, and it used `UndecidableInstances` extension. I replaced ToArrayCallback with VariadicCallback and VariadicCallbackReturn. Both VariadicCallback and VariadicCallbackReturn are much easier to understand and use. The functions that use VariadicCallback(Return) have simpler types than those that use ToArrayCallback.

It is no longer necessary after replacing ToArrayCallback with VariadicCallback(Return)

After IsJSVal was replaced with PFromJSVal, the comments on variadic callback generators weren't updated.

With UndecidableInstances, I can remove helper functions. Do not fear UndecidableInstances. UndecidableInstances just makes programmers responsible for making instance resolution terminate in a finite amount of time.

array copy is eliminated, and variadic callback generators work directly on JSArray.

crocket added 4 commits October 29, 2016 11:23

README : new section for multi-argument callbacks

73b5308

Interchange sections to improve readability.

0b67348

It interchanges a section on a callback example with a section on multi-argument callbacks

Improve the example for multi-argument callback

529c4d5

README now shows an example of using `syncCallbackMulti'` instead of `asyncCallbackMulti`.

hamishmack reviewed Oct 29, 2016

View reviewed changes

Restore haddock markup cues.

3a85667

I made a mistake of removing haddock markup cues because I still don't know how to use haddock.

crocket mentioned this pull request Oct 31, 2016

Submit ghcjs-base to hackage #81

Closed

crocket added 2 commits October 31, 2016 22:06

Improve multi-argument callback example on README

6c0d009

Polish multi-argument callback example on README

de88523

crocket added 7 commits November 1, 2016 11:57

Polish multi-argument callback example on README

0ab99fe

JavaScript.Array.toListIO > GHCJS.Prim.fromJSArray

4aff961

Replace JavaScript.Array.toListIO with GHCJS.Prim.fromJSArray in GHCJS/Foreign/Callback.hs

Revamp multi-argument callback generators.

31502ce

Previously, they were cumbersome to use. Now, they are a lot easier to use.

Fix typo in README

2937486

Fix typo in README

94502c2

Explain multi-argument callback generators better.

a1fd093

Forgot to add ToArrayCallback.hs

0bdb135

crocket added 10 commits November 9, 2016 20:05

Remove FlexibleContexts from Callback.hs

957916a

It is no longer necessary after replacing ToArrayCallback with VariadicCallback(Return)

Fix explanation of variadic callbacks on README.

4fa772b

Refactor VariadicCallback

f278eb7

PFromJSVal subsitutes IsJSVal in VariadicCallback

7b1a13e

Don't export Variadic from Callback.hs

e3c5fe5

Slightly improve wording in README

d15783a

instance IsJSVal JSVal is not necessary anymore.

b6d1699

Update comments in variadic callback generators.

fe353b5

After IsJSVal was replaced with PFromJSVal, the comments on variadic callback generators weren't updated.

Simplify GHCJS.Foreign.Callback.Variadic

26342b0

With UndecidableInstances, I can remove helper functions. Do not fear UndecidableInstances. UndecidableInstances just makes programmers responsible for making instance resolution terminate in a finite amount of time.

Make variadic callback generators more efficient.

e31f93a

array copy is eliminated, and variadic callback generators work directly on JSArray.

crocket closed this Nov 14, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add multi argument callback helpers. #77

Add multi argument callback helpers. #77

crocket commented Oct 29, 2016 •

edited

hamishmack Oct 29, 2016

crocket Oct 29, 2016 •

edited

hamishmack commented Oct 29, 2016

crocket commented Oct 31, 2016 •

edited

hamishmack commented Nov 1, 2016

crocket commented Nov 9, 2016 •

edited

Add multi argument callback helpers. #77

Add multi argument callback helpers. #77

Conversation

crocket commented Oct 29, 2016 • edited

hamishmack Oct 29, 2016

Choose a reason for hiding this comment

crocket Oct 29, 2016 • edited

Choose a reason for hiding this comment

hamishmack commented Oct 29, 2016

crocket commented Oct 31, 2016 • edited

hamishmack commented Nov 1, 2016

crocket commented Nov 9, 2016 • edited

crocket commented Oct 29, 2016 •

edited

crocket Oct 29, 2016 •

edited

crocket commented Oct 31, 2016 •

edited

crocket commented Nov 9, 2016 •

edited