| Help understanding code assist [message #1416801] |
Wed, 20 February 2013 17:00  |
Eclipse User |
|
|
|
I'm relatively new to Lua, and very new to Koneki. I've setup the LDT tool and been able to get a project setup and working with most functionality. I'm confused though on exactly what I can auto-complete and ctrl-click. If everything is local it seems that things are working okay, but I'm trying to figure out what I can do with modules.
To be specific -
If I have
-- simpleModuleA.lua
module(..., package.seeall)
function myFunc()
print('hello')
end
-- useModule.lua
local myModA = require('simpleModuleA')
-- insert question code here.
If at the point noted in the code I start typing "myMo" and then hit ctrl-space it will auto complete the local variable "myModA". However, if then have "myModA." and hit ctrl-space I do not get any suggestions for available functions. Is this normal?
Also if I have in the code "myModA.myFunc()" I cannot ctrl-click on "myFunc" and go to the definition of myFunc. However, if I ctrl-click on "MyModA" and get taken to the declaration of myModA.
Is this the expected behavior or do I have something set up wrong. I would really like the ability to ctrl-click into my modules or have auto-complete for functions.
Also, when I am writing simpleModuleA I have to have everything 'global' in that file (i.e. "function myFunc" instead of "local function myFunc") in order to have it visible when I try to do myModA.myFunc. If that is the case I can't have any auto completion on that function when writing that file because it is a global?
Thanks for helping me understand this.
|
|
|
| Re: Help understanding code assist [message #1416802 is a reply to message #1416801] |
Thu, 21 February 2013 14:24  |
 Kevin KIN-FOO
Messages: 28
Registered: July 2009 |
Junior Member |
|
|
Hi Kevin,
About modules, the module function won't work with Lua 5.2. So, you might start to create modules from tables. Then, in this case, you will not handle any globals.
local M = {}
M.myFunc = function()
print('hello')
end
return M
As I'm writing, we analyze modules from their documentation comments[1]. Your module was not documented, that is why you did not have content assist available on it. Once documented, Ctrl-clicking your module's attributes will lead you to their documentation.
To unleash Koneki LDT you might read its Getting Started[2] from its User Guide[3], thanks for your feedback.
Kévin
[1] Lua Documentation Language: http://wiki.eclipse.org/Koneki/LDT/User_Area/Documentation_Language
[2] Getting Started: http://wiki.eclipse.org/Koneki/LDT/Developer_Area/User_Guides/User_Guide_0.9#Getting_started
[3] User Guide: http://wiki.eclipse.org/Koneki/LDT/Developer_Area/User_Guides/User_Guide_0.9
|
|
|
|
| Re: Help understanding code assist [message #1416804 is a reply to message #1416802] |
Thu, 21 February 2013 16:50 |
| Eclipse User |
|
|
|
Thank you for your response. I had already read through the guides you mentioned, though I may have missed a few things. Also, my actual code is documented according that which is described in the documentation guide (at least I think it conforms - it works correctly with the html document generator). I realized after I posted that I should have put that in my example.
The reason I am using the 'module' function is a bit complex though. I am working with another piece of software which parses lua files and is looking for very specific naming conventions. The code requires the prefix 'cmp' on the table name and does not allow '.' as a valid character in the name. Such that cmpMyThing is valid but M.cmpMyThing is not valid, nor would be cmp.MyThing. This is less than ideal, but is what I have to deal with in the short term. Long term I may be able to change the parsing algorithm. To get around this right now I am using the module function, which allows me to just put cmpMyThing into the file as a global. This makes the parser happy. I am using the 'squish' utility to merge files together into a single file (also required for this software). This utility leaves the cmpMyThing intact so that it can still be parsed properly.
Anyway, your post leads me to believe I need to do two things
1. Create a more simple example than my current code to try out if code assist is working properly
2. Examine other possibilities of how to work around the limitations of my software if I want to use all the features of LDT. I would rather use the method you described for creating modules, but I need to figure out another way to make it work with the parsing constraints I have.
I'll post again if my experimenting with code assist fails.
Kevin
|
|
|
|
| Re: Help understanding code assist [message #1416806 is a reply to message #1416805] |
Fri, 22 February 2013 22:24 |
| Eclipse User |
|
|
|
Ok, sorry, I'm still confused on one point. If I make my tables fields I can see them outside the module with code assist. But I don't understand how to see something inside that table. Can I only go one level deep?
As example again -
---
-- Simple Module for testing documentation.
-- Just for test.
--
-- @module docTest
local M = {}
---
-- A Table.
-- What should this be??? A field, a Type?
--
-- @field [parent=#docTest] #table myTable
M.myTable = {}
---
-- Function in a table.
-- What should the parent be???
--
-- @function [parent=#myTable] myFunc
function M.myTable.myFunc()
-- Do something
end
return M
If I do this outside the module
local test = require 'docTest'
test.myTable.--try auto complete here
I can't auto complete to get the function myFunc. Is this possible, and if so what do I need to do to make the documentation work correctly? I'm confused at exactly when you use the '@type' in the documentation. Originally I thought that I should use that on my tables so I could then use the @field for the table fields. But that doesn't work either because then I can't see my table outside the module.
Thanks for any help.
Kevin
|
|
|
| Re: Help understanding code assist [message #1416808 is a reply to message #1416806] |
Tue, 26 February 2013 12:48 |
Marc Aubry
Messages: 76
Registered: July 2009 |
Member |
|
|
Hi Kevin,
You're right, the @type is the clue.
The @type allow to define a kind of set/container of functions and fields. You can also associate a type to a variable such as a function return or a field.
If a variable have a defined type, the auto-completion will known all the functions and fields available on it.
To fix your code, you just need to declare the new type "mytable" using @type,
set the field type to #mytable instead of #table, and set the parent of MyFunc to "#mytable".
---
-- Simple Module for testing documentation.
-- Just for test.
--
-- @module docTest
local M = {}
--- @type mytable
---
-- A Table.
-- What should this be??? A field, a Type?
--
-- @field [parent=#docTest] #mytable myTable
M.myTable = {}
---
-- Function in a table.
-- What should the parent be???
--
-- @function [parent=#mytable] myFunc
function M.myTable.myFunc()
-- Do something
end
return M
Now, when you require the module "testdoc" in an other file. The test variable will be associated to the type "docTest", so you can call the field "mytable". And as the field myTable is associated with the type "mytable" the function "myfunc" is available for the auto completion.
I hope theses explanations can help you.
Feel free to post here if you have any feedback on this mechanic or the documentation, it's helpful for us to understand Lua developer point of view.
Marc
|
|
|
|
| Re: Help understanding code assist [message #1416811 is a reply to message #1416810] |
Wed, 27 February 2013 16:50 |
| Eclipse User |
|
|
|
Thank you for your help on this. As for feedback - I think it would be helpful to have an example of this in the documentation. I read through it several times and could still not figure out exactly how to use the @type keyword. I think showing an example with creating a type and then using it would be very helpful. I did not realize that I would need to say '#myTable myTable'. I would have thought that it could have inferred that by simply giving the name 'myTable'. I missed the fact that it is both a field AND a type, and that I have to explicitly declare both.
As I read back through the documentation I think that things that were difficult for me is the language for a field 'It is always a field of a type'. That makes me feel like they are mutually exclusive things. I was thinking of my table as the parent to the fields inside the table - and thus it must be a type. But if it is a type it is not a field. As I now understand it, though, the type is just an arbitrary tag to which to attach things and is not actually tied to the table itself (that is I can call my type 'bob' and declare a field as #bob myTable). In any case I think a simple example showing that would make all troubles understanding go away. As it stands the one 'Sample mixing code and comments' does not declare a new type and use it. Just adding a few lines of code to that example, I think, would make it much more clear how to use it.
One other comment on the documentation system - I noticed that since the autocomplete is based solely on the documentation it is possible to autocomplete something that is not legal. If I mistype the name of my field when creating the documentation (i.e. myTalbe) then when I ctrl-space it will suggest the incorrect value name. I'm sure you're already aware of that limitation but I thought I would mention that I noticed it as a potential problem.
Thanks again. I really appreciate your responsiveness in this forum. That is the primary reason I decided to go with LDT over other options - it seemed to be the tool with most active development and community participation.
|
|
|
|
| Re: Help understanding code assist [message #1416816 is a reply to message #1416812] |
Mon, 04 March 2013 22:27 |
| Eclipse User |
|
|
|
I think your code example makes the ideas more clear. It makes more sense to see explicitly defining a type and then setting something else to be of that type. I may not always think of coding this way though, if I'm only making one of the type. There's not really a point in declaring a type (T) only to give it a different name (myTable) a few lines later. If I'm going to make more than one (i.e. I also have mySecondTable = T) then I would definitely think about coding it as you have described. But in any case I think that example clearly illustrates how to use the documentation to define a type and shows why it is the way it is.
One other question for you - While I'm working inside the module do I have any way to use the autocomplete? For instance, if in your example, right before the line 'return M' if I type 'M.' and try to ctrl-space I don't get any information about fields in my module (docTest). If I want to get myTable, or even myTable.myFunc while I'm still writing inside the module can I do that?
|
|
|
|
Powered by
FUDForum. Page generated in 0.03247 seconds
] 
Search
Help
Register
Login
Home
