aboutsummaryrefslogblamecommitdiffstats
path: root/legacy/evas/src/lib/canvas/evas_clip.c
blob: d412e435fa537268b48f3b2e39bf20235b60f0e7 (plain) (tree)
1
2
3
4
5
6
7
8
9

                         

    
                                                                                        
 

                     
 
                                         
 
                                 
                                             
                                                



                                                   


    
                                                                                 
 

                     
 
                                 
      
                                             
                                                     



                                                                                    



      
                                                                                                  


                         






                                                                                     



            
                                     
  



                                                                             
  















                                                                            
  




                                                                               
  

                                                                           

   
                    
           
                                                                                                                              
 

                                                 
      

                                      

                                             
           
                                              
 
                                                                                    


                                                                      

                                                                                   

                


                                   
                                  
 




                                                                                          
           
      
      

 
    
                                                                                   
 
                 
                                 


                                                                                       
      


    
                                                                                            


                 
                        

                                  
                     
                                                                       
         
                                                                          

                                 




                                                                                     
      
      



                                                                             
  
                                                                
    
                                                                                         
 
                 
                                           
                                                                
       

                              





                                                                   
            

                                                                   
      

 
                      
                               
 
         


                          
 
                                               

                     








                                                       
      
                                       
               
      
                                                

                     


                                                                           
      
                                                  



                       
                                                                          




                      
                                                                             




                   
                                                                    










                                                                                                                
                                                                         
                                                  




                                                                           
                     
      
                                                        


                        



                                                                                                
           






                                                                        
           

                                                          
                                

                
                                                    
      


                                              
                                                          

                                                                              
      

                                                                     



                                   
                                                         
      


                                                      
                                 
                           

       
                      

                                                       



                                                          
      




                                            
                                                
      
                                                      

                                                                             
                                                            



                                                                      
      
                                              

 
                  
                                               
 
                                               

                     










                                                           

 
         
                                           
 
                                               

                     






                                                             

                                 

                                                             
      
                                                   
      
                        
      


                                                                                                
           






                                                                         
           
                                                          
      
                           



                                            
                                                
      
                                                      

                                                                             
                                                            

                                                                 
                                                                      
                                           
      
                                              

 
                      
                                                  
 
                                               

                     










                                                                 
 
 
#include "evas_common.h"
#include "evas_private.h"

void
evas_object_clip_dirty(Evas_Object *eo_obj EINA_UNUSED, Evas_Object_Protected_Data *obj)
{
   Eina_List *l;
   Evas_Object *data;

   if (obj->cur.cache.clip.dirty) return;

   obj->cur.cache.clip.dirty = 1;
   Evas_Object_Protected_Data *clipee = NULL;
   EINA_LIST_FOREACH(obj->clip.clipees, l, data)
     {
        clipee = eo_data_get(data, EVAS_OBJ_CLASS);
        evas_object_clip_dirty(data, clipee);
     }
}

void
evas_object_recalc_clippees(Evas_Object *eo_obj, Evas_Object_Protected_Data *obj)
{
   Eina_List *l;
   Evas_Object *data;

   if (obj->cur.cache.clip.dirty)
     {
        evas_object_clip_recalc(eo_obj, obj);
        EINA_LIST_FOREACH(obj->clip.clipees, l, data)
          {
             Evas_Object_Protected_Data *clipee = eo_data_get(data, EVAS_OBJ_CLASS);
             evas_object_recalc_clippees(data, clipee);
          }
     }
}

int
evas_object_clippers_was_visible(Evas_Object *eo_obj EINA_UNUSED, Evas_Object_Protected_Data *obj)
{
   if (obj->prev.visible)
     {
	if (obj->prev.clipper)
          {
             Evas_Object_Protected_Data *prev_clipper =
                eo_data_get(obj->prev.clipper, EVAS_OBJ_CLASS);
             return evas_object_clippers_is_visible(obj->prev.clipper, prev_clipper);
          }
	return 1;
     }
   return 0;
}

/* aaaaargh (pirate voice) ... notes!
 *
 * we have a big problem until now that's gone undetected... until yesterday.
 * that problem involves clips and maps and smart objects. hooray! 3 of the
 * more complex bits of evas - and maps and smart objects  being one of the
 * nastiest ones.
 *
 * what is the problem? when a clip crosses a map boundary. that is to say
 * that when the clipper and clippee are not within the child tree of the
 * mapped object. in this case "bad stuff" happens. basically as clips are
 * then used to render objects, but they no longer apply as you'd expect as
 * the map transfomr the objects to-be-clipped separately from the objects
 * that clip them and this whole relationship is broken by maps. it somehow
 * managed to not break with the advent of smart objects. lucky me... but
 * maps killed it. now... what do we do? that is a good question. detect
 * such a broken link and "turn off clipping" in that event - sure. but this
 * isn't going to be cheap as ANY addition or deletion of a map to an object
 * or any change in clipper of an object or any change in smart object
 * membership needs to walk the obj tree both up and down from the changed
 * object and probably walk entire object trees to find these and mark them.
 * thats silly-expensive and i was about to fix it that way but it has since
 * dawned on me that that is just going to kill performance in some critical
 * areas like during object setup and manipulation, as well as teardown.
 *
 * aaaaagh! best for now is to document this as a "don't do it damnit!" thing
 * and have the apps avoid it. but even then - how to do this? this is not
 * easy. everywhere i turn so far i come up to either expensive operations,
 * breaks in logic, or nasty re-work of apps or4 the whole concept of clipping,
 * smart objects and maps... and that will have to wait for evas 2.0
 *
 * the below does clip fixups etc. in the even a clip spans a map boundary.
 * not pretty, but necessary.
 */

#define MAP_ACROSS 1
static void
evas_object_child_map_across_mark(Evas_Object *eo_obj, Evas_Object_Protected_Data *obj, Evas_Object *map_obj, Eina_Bool force)
{
#ifdef MAP_ACROSS
   if ((obj->cur.map_parent != map_obj) || force)
     {
        obj->cur.map_parent = map_obj;
        obj->cur.cache.clip.dirty = 1;
        evas_object_clip_recalc(eo_obj, obj);
        if (obj->is_smart)
          {
             Evas_Object_Protected_Data *obj2;

             EINA_INLIST_FOREACH(evas_object_smart_members_get_direct(eo_obj), obj2)
               {
                  // if obj has its own map - skip it. already done
                  if ((obj2->cur.map) && (obj2->cur.usemap)) continue;
                  Evas_Object *eo_obj2 = obj2->object;
                  evas_object_child_map_across_mark(eo_obj2, obj2, map_obj, force);
               }
          }
        else if (obj->clip.clipees)
          {
             Eina_List *l;
             Evas_Object *eo_obj2;

             EINA_LIST_FOREACH(obj->clip.clipees, l, eo_obj2)
               {
                  Evas_Object_Protected_Data *obj2 = eo_data_get(eo_obj2, EVAS_OBJ_CLASS);
                  evas_object_child_map_across_mark(eo_obj2, obj2, map_obj, force);
               }
          }
     }
#endif
}

void
evas_object_clip_across_check(Evas_Object *eo_obj, Evas_Object_Protected_Data *obj)
{
#ifdef MAP_ACROSS
   if (!obj->cur.clipper) return;
   Evas_Object_Protected_Data *clipper = eo_data_get(obj->cur.clipper, EVAS_OBJ_CLASS);
   if (clipper->cur.map_parent != obj->cur.map_parent)
      evas_object_child_map_across_mark(eo_obj, obj, obj->cur.map_parent, 1);
#endif
}

void
evas_object_clip_across_clippees_check(Evas_Object *eo_obj, Evas_Object_Protected_Data *obj)
{
#ifdef MAP_ACROSS
   Eina_List *l;
   Evas_Object *eo_obj2;

   if (!obj->clip.clipees) return;
// schloooooooooooow:
//   evas_object_child_map_across_mark(eo_obj, obj->cur.map_parent, 1);
// buggy:
   evas_object_child_map_across_mark(eo_obj, obj, obj->cur.map_parent, 0);
   if (obj->cur.cache.clip.dirty)
     {
	EINA_LIST_FOREACH(obj->clip.clipees, l, eo_obj2)
          {
             Evas_Object_Protected_Data *obj2 = eo_data_get(eo_obj2, EVAS_OBJ_CLASS);
             evas_object_clip_across_clippees_check(eo_obj2, obj2);
          }
     }
#endif
}

// this function is called on an object when map is enabled or disabled on it
// thus creating a "map boundary" at that point.
//
// FIXME: flip2 test broken in elm - might be show/hide of clips
void
evas_object_mapped_clip_across_mark(Evas_Object *eo_obj, Evas_Object_Protected_Data *obj)
{
#ifdef MAP_ACROSS
   if ((obj->cur.map) && (obj->cur.usemap))
      evas_object_child_map_across_mark(eo_obj, obj, eo_obj, 0);
   else
     {
        if (obj->smart.parent)
          {
             Evas_Object_Protected_Data *smart_parent_obj =
                eo_data_get(obj->smart.parent, EVAS_OBJ_CLASS);
             evas_object_child_map_across_mark
                (eo_obj, obj, smart_parent_obj->cur.map_parent, 0);
          }
        else
           evas_object_child_map_across_mark(eo_obj, obj, NULL, 0);
    }
#endif
}

/* public functions */
extern const char *o_rect_type;

EAPI void
evas_object_clip_set(
      Evas_Object *eo_obj,
      Evas_Object *clip)
{
   MAGIC_CHECK(eo_obj, Evas_Object, MAGIC_OBJ);
   return;
   MAGIC_CHECK_END();
   eo_do(eo_obj, evas_obj_clip_set(clip));
}

void
_clip_set(Eo *eo_obj, void *_pd, va_list *list)
{
   Evas_Object *eo_clip = va_arg(*list, Evas_Object *);
   Evas_Object_Protected_Data *obj = _pd;
   if (!eo_clip)
     {
        evas_object_clip_unset(eo_obj);
        return;
     }
   MAGIC_CHECK(eo_clip, Evas_Object, MAGIC_OBJ);
   return;
   MAGIC_CHECK_END();
   Evas_Object_Protected_Data *clip = eo_data_get(eo_clip, EVAS_OBJ_CLASS);
   if (obj->cur.clipper == eo_clip) return;
   if (eo_obj == eo_clip)
     {
        CRIT("Setting clip %p on itself", eo_obj);
        return;
     }
   if (clip->delete_me)
     {
        CRIT("Setting deleted object %p as clip obj %p", eo_clip, eo_obj);
        abort();
        return;
     }
   if (obj->delete_me)
     {
        CRIT("Setting object %p as clip to deleted obj %p", eo_clip, eo_obj);
        abort();
        return;
     }
   if (!obj->layer)
     {
        CRIT("No evas surface associated with object (%p)", eo_obj);
        abort();
        return;
     }
   if ((obj->layer && clip->layer) &&
       (obj->layer->evas != clip->layer->evas))
     {
        CRIT("Setting object %p from Evas (%p) to another Evas (%p)", obj, obj->layer->evas, clip->layer->evas);
        abort();
        return;
     }

   if (evas_object_intercept_call_clip_set(eo_obj, obj, eo_clip)) return;
   // illegal to set anything but a rect as a clip
   if (clip->type != o_rect_type)
     {
        ERR("For now a clip on other object than a rectangle is disabled");
        return;
     }
   if (obj->is_smart)
     {
        eo_do(eo_obj, evas_obj_smart_clip_set(eo_clip));
     }
   if (obj->cur.clipper)
     {
	/* unclip */
        Evas_Object_Protected_Data *cur_clipper = eo_data_get(obj->cur.clipper, EVAS_OBJ_CLASS);
        cur_clipper->clip.clipees = eina_list_remove(cur_clipper->clip.clipees, eo_obj);
        if (!cur_clipper->clip.clipees)
          {
             cur_clipper->cur.have_clipees = 0;
             if (cur_clipper->cur.visible)
               evas_damage_rectangle_add(cur_clipper->layer->evas->evas,
                                         cur_clipper->cur.geometry.x,
                                         cur_clipper->cur.geometry.y,
                                         cur_clipper->cur.geometry.w,
                                         cur_clipper->cur.geometry.h);
          }
        evas_object_change(obj->cur.clipper, cur_clipper);
        evas_object_change(eo_obj, obj);
        obj->cur.clipper = NULL;
     }
   /* clip me */
   if ((!clip->clip.clipees) && (clip->cur.visible))
     {
        /* Basically it just went invisible */
        clip->changed = 1;
        clip->layer->evas->changed = 1;
        evas_damage_rectangle_add(clip->layer->evas->evas,
                                  clip->cur.geometry.x, clip->cur.geometry.y,
                                  clip->cur.geometry.w, clip->cur.geometry.h);
     }
   obj->cur.clipper = eo_clip;
   clip->clip.clipees = eina_list_append(clip->clip.clipees, eo_obj);
   if (clip->clip.clipees)
     {
        clip->cur.have_clipees = 1;
        if (clip->changed)
          evas_object_update_bounding_box(eo_clip, clip);
     }

   /* If it's NOT a rectangle set the mask bits too */
   /* FIXME: Optmz ths chck */
   if (clip->type == o_rect_type)
      obj->cur.mask = NULL;
   else
     {
        void *engdata;
        obj->cur.mask = eo_clip;
        engdata = clip->func->engine_data_get(eo_clip);
        /* FIXME: Images only */
        clip->layer->evas->engine.func->image_mask_create(
          clip->layer->evas->engine.data.output,
          engdata);
     }
   evas_object_change(eo_clip, clip);
   evas_object_change(eo_obj, obj);
   evas_object_clip_dirty(eo_obj, obj);
   evas_object_recalc_clippees(eo_obj, obj);
   if ((!obj->is_smart) &&
       (!((obj->cur.map) && (obj->cur.usemap))))
     {
        if (evas_object_is_in_output_rect(eo_obj, obj,
                                          obj->layer->evas->pointer.x,
                                          obj->layer->evas->pointer.y, 1, 1))
          evas_event_feed_mouse_move(obj->layer->evas->evas,
                                     obj->layer->evas->pointer.x,
                                     obj->layer->evas->pointer.y,
                                     obj->layer->evas->last_timestamp,
                                     NULL);
     }
   evas_object_clip_across_check(eo_obj, obj);
}

EAPI Evas_Object *
evas_object_clip_get(const Evas_Object *eo_obj)
{
   MAGIC_CHECK(eo_obj, Evas_Object, MAGIC_OBJ);
   return NULL;
   MAGIC_CHECK_END();
   Evas_Object *clip = NULL;
   eo_do((Eo *)eo_obj, evas_obj_clip_get(&clip));
   return clip;
}

void
_clip_get(Eo *eo_obj EINA_UNUSED, void *_pd, va_list *list)
{
   Evas_Object **clip = va_arg(*list, Evas_Object **);
   const Evas_Object_Protected_Data *obj = _pd;
   *clip = obj->cur.clipper;
}

EAPI void
evas_object_clip_unset(Evas_Object *eo_obj)
{
   MAGIC_CHECK(eo_obj, Evas_Object, MAGIC_OBJ);
   return;
   MAGIC_CHECK_END();
   eo_do(eo_obj, evas_obj_clip_unset());
}

void
_clip_unset(Eo *eo_obj, void *_pd, va_list *list EINA_UNUSED)
{
   Evas_Object_Protected_Data *obj = _pd;
   if (!obj->cur.clipper) return;
   /* unclip */
   if (evas_object_intercept_call_clip_unset(eo_obj)) return;
   if (obj->is_smart)
     {
        eo_do(eo_obj, evas_obj_smart_clip_unset());
     }
   if (obj->cur.clipper)
     {
        Evas_Object_Protected_Data *cur_clipper = eo_data_get(obj->cur.clipper, EVAS_OBJ_CLASS);
        cur_clipper->clip.clipees = eina_list_remove(cur_clipper->clip.clipees, eo_obj);
        if (!cur_clipper->clip.clipees)
          {
             cur_clipper->cur.have_clipees = 0;
             if (cur_clipper->cur.visible)
                evas_damage_rectangle_add(cur_clipper->layer->evas->evas,
                                         cur_clipper->cur.geometry.x,
                                         cur_clipper->cur.geometry.y,
                                         cur_clipper->cur.geometry.w,
                                         cur_clipper->cur.geometry.h);
          }
	evas_object_change(obj->cur.clipper, cur_clipper);
     }
   obj->cur.clipper = NULL;
   evas_object_change(eo_obj, obj);
   evas_object_clip_dirty(eo_obj, obj);
   evas_object_recalc_clippees(eo_obj, obj);
   if ((!obj->is_smart) &&
       (!((obj->cur.map) && (obj->cur.usemap))))
     {
        if (evas_object_is_in_output_rect(eo_obj, obj,
                                          obj->layer->evas->pointer.x,
                                          obj->layer->evas->pointer.y, 1, 1))
          evas_event_feed_mouse_move(obj->layer->evas->evas,
                                     obj->layer->evas->pointer.x,
                                     obj->layer->evas->pointer.y,
                                     obj->layer->evas->last_timestamp,
                                     NULL);
     }
   evas_object_clip_across_check(eo_obj, obj);
}

EAPI const Eina_List *
evas_object_clipees_get(const Evas_Object *eo_obj)
{
   MAGIC_CHECK(eo_obj, Evas_Object, MAGIC_OBJ);
   return NULL;
   MAGIC_CHECK_END();
   const Eina_List *clipees = NULL;
   eo_do((Eo *)eo_obj, evas_obj_clipees_get(&clipees));
   return clipees;
}

void
_clipees_get(Eo *eo_obj EINA_UNUSED, void *_pd, va_list *list)
{
   const Eina_List **clipees = va_arg(*list, const Eina_List **);
   const Evas_Object_Protected_Data *obj = _pd;
   *clipees = obj->clip.clipees;
}